Updraft
Options
All
  • Public
  • Public/Protected
  • All
Menu

Updraft

Updraft is an asynchronous Javascript object-relational mapping (ORM)-like library, very similar to persistence.js. It can work in the browser, on a server using node.js, or in a Cordova app using the SQLitePlugin (basically, anywhere WebSQL or a SQLlite interface is supported). It does not support MySQL, in-memory, local storage, or IndexedDB.

Status

Updraft has not yet been used in any project and is still under heavy development. Expect bugs. You shouldn't use it if you know nothing about SQL.

Sync is planned but not implemented.

Motivations

Change history

Most databases store only the latest records, which works well when there is only one database. Once you start syncing between multiple databases, you start running into problems. How do you merge records? What if one user deleted a record that another modified?

Updraft addresses these problems by storing baseline records and changes. Users can insert a baseline (that is, whole) record at any time, but this is intended to be done only once, because only the latest record is considered the baseline. Subsequent modifications should be made as mutators- you tell the database to made a change, and it applies the mutator to the latest record, as well as keeping a record of the changes. Every time a change comes in, it runs all the mutators in the order and updates the latest record.

This system makes conflict resolution trivial- if two users change the same record offline, once they resume syncing their changes will automatically merge based on the time they came in.

Mutators

Mutators are based on React's immutability helpers, which in turn is based on MongoDB's query language, though there is no tie to any database. They are immutable operations, meaning they leave the source object untouched.
For example:

var record = {
  id: 123,
  text: "original text"
};

var mutator = {
  text: { $set: "new text" }
};

var newRecord = Updraft.mutate(record, mutator);
// record -> { id: 123, text: "original text" }
// newRecord -> { id: 123, text: "new text" }

Important differences from other ORM frameworks

You should think of Updraft as more of a wrapper over executing SQL statements yourself, rather than a complete ORM framework. Objects won't be cached or saved unless you do it yourself. You will have to define your primary key (only one is supported) as well as create and assign a unique value for that key.

You also won't find one-to-one or many-to-many or other SQL-centric ideas. You can define a field of type 'set' where you can have a (homogeneous) set of values or object keys. You will be responsible for tracking object lifetimes and deleting any orphaned entities.

Dependencies

You need a JS environment that supports Promises or you can use a library like lie.

Though written in TypeScript, it will run in any JS environment (browser, node.js)

Installation

npm:

npm install --save updraft

Bower:

bower install --save updraft

Usage

Basic usage is as follows:

var taskSpec = {
  name: 'tasks',
  columns: {
    id: Updraft.Column.Text().Key(),
    description: Updraft.Column.Text(),
    done: Updraft.Column.Bool()
  }
};

var sqlite3 = require("sqlite3");
var db = new sqlite3.Database("test.db");

var store = new Updraft.createStore({ db: Updraft.createSQLiteWrapper(db) });
var taskTable = store.createTable(taskSpec);
var time = Date.now();

store.open({name: 'my database'})
  .then(function() {

    var task = {
      id: 123,
      description: "task description",
      done: false
    };

    // save baseline
    return taskTable.add([{ time: time + 0, save: task }]);
  })
  .then(function() {

    var change = {
      description: { $set: "changed description" },
      done: { $set: true }
    };

    // in a real application you would just use Date.now(), since it's probably not the
    // same second you created the record
    time = time + 1;

    // save the change
    return taskTable.add([{ time: time, change: change }]);
  })
  .then(function() {
    // find the value with id 123.  See docs for more advanced query options
    return taskTable.find({id: 123});
  })
  .then(function(results) {
    var task = results[0];
    // -> { id: 123, description: "changed description" }
  })
  ;

If you use TypeScript, you can use interfaces to make your life easier and let the compiler catch errors:

import M = Updraft.Mutators;
import Q = Updraft.Query;

// either set up multiple interfaces for declarations and queries:
interface Task {
  id: number;
  description: string;
  done: boolean; 
}

interface TaskMutator {
  id: number; // NOTE: database does not support changing the key value
  description: M.str;
  done: M.bool;
}

interface TaskQuery {
  id: Q.num;
  description: Q.str;
  done: Q.bool;
}

// or use templates to keep things [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
interface _Task<key, str, bool> {
  id: key;
  description: str;
  done: bool;
}

interface Task extends _Task<number, string, boolean> {}
interface TaskMutator extends _Task<number, M.str, M.bool> {}
interface TaskQuery extends _Task<Q.num, Q.str, Q.bool> {}

// then set up your table
type TaskTable = Updraft.Table<Task, TaskMutator, TaskQuery>;
type TaskChange = Updraft.TableChange<Task, TaskMutator>;
type TaskTableSpec = Updraft.TableSpec<Task, TaskMutator, TaskQuery>;

const taskSpec: TaskTableSpec = {
  name: 'tasks',
  columns: {
    id: Updraft.Column.Text().Key(),
    description: Updraft.Column.Text(),
    done: Updraft.Column.Bool()
  }
};

// ...

var store = new Updraft.createStore({ db: Updraft.createSQLiteWrapper(db) });
var taskTable: TaskTable = store.createTable(TaskSpec);

For advanced usage, see the documentation.

Enums

Updraft supports typescript enums and enum-like objects, such as those created using the enum library, with no dependency on any specific library. They will be saved as the object's 'toString()' value and restored using the class's 'get(value)' method. They are stored in the db as strings.


var store = new Updraft.createStore(/* ... */);

var ColorTemperature = new Enum({'Cool', 'Neutral', 'Warm'});

var paintTable = store.createClass({
  tableName: 'paints',
  columns: {
    name: Updraft.Column.Text().Key(),
    colorTemp: Updraft.Column.Enum(ColorTemperature)
  }
});

var paint = {
  name: "cyan",
  colorTemp: ColorTemperature.Cool,
};

// ...

paintTable.find({ colorTemp: ColorTemperature.Cool }).then(/* ... */);

Schemas and Migration

For most simple changes, Updraft will have you covered. You can feel free to add a new field, a new class, remove fields or classes, add or remove indices, and rename fields without needing to do any extra work. You can also change field types, but because the underlying database is SQLite, the 'type' is only a column affinity- no schema change/migration will happen; you can always store any type (int/string/blob/etc) in any field.

During migrations, removed and renamed columns will be preserved not only in the resulting table but also by walking every change and updating the columns on the mutator objects. Because of this, it might take some time depending on how many records you have.

Not supported:

  • changing the primary key
  • changing table names
  • multi-column primary keys

Documentation

There is auto-generated documentation in doc/index.html

For examples see the test folder

Contributing

We'll check out your contribution if you:

  • Provide a comprehensive suite of tests for your fork.
  • Have a clear and documented rationale for your changes.
  • Package these up in a pull request.

We'll do our best to help you out with any contribution issues you may have.

License

MIT. See LICENSE.txt in this directory.

Index

Modules

"assert"

"assert":

internal

  • internal(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

AssertionError

AssertionError:

constructor

  • Parameters

    • Optional options: object
      • Optional actual?: any
      • Optional expected?: any
      • Optional message?: string
      • Optional operator?: string
      • Optional stackStartFunction?: Function

    Returns AssertionError

actual

actual: any

expected

expected: any

generatedMessage

generatedMessage: boolean

message

message: string

name

name: string

operator

operator: string

doesNotThrow

doesNotThrow: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void
    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean
          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

throws

throws: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void
    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean
          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

deepEqual

  • deepEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

equal

  • equal(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

fail

  • fail(actual?: any, expected?: any, message?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

ifError

  • ifError(value: any): void
  • Parameters

    • value: any

    Returns void

notDeepEqual

  • notDeepEqual(acutal: any, expected: any, message?: string): void
  • Parameters

    • acutal: any
    • expected: any
    • Optional message: string

    Returns void

notEqual

  • notEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

notStrictEqual

  • notStrictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

ok

  • ok(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

strictEqual

  • strictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

"buffer"

"buffer":
                                          *
              MODULES                     *
                                          *

INSPECT_MAX_BYTES

INSPECT_MAX_BYTES: number

"chai"

"chai":

"chai-as-promised"

"chai-as-promised":

chaiAsPromised

  • chaiAsPromised(chai: any, utils: any): void
  • Parameters

    • chai: any
    • utils: any

    Returns void

"chai-datetime"

"chai-datetime":

chaiDateTime

  • chaiDateTime(chai: any, utils: any): void
  • Parameters

    • chai: any
    • utils: any

    Returns void

"child_process"

"child_process":

ChildProcess

ChildProcess:

pid

pid: number

stderr

stderr: Readable

stdin

stdin: Writable

stdout

stdout: Readable

addListener

  • addListener(event: string, listener: Function): EventEmitter

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

kill

  • kill(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unref

  • unref(): void
  • Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

exec

  • exec(command: string, options: object, callback?: function): ChildProcess
  • exec(command: string, callback?: function): ChildProcess
  • Parameters

    • command: string
    • options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • command: string
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

execFile

  • execFile(file: string, callback?: function): ChildProcess
  • execFile(file: string, args?: string[], callback?: function): ChildProcess
  • execFile(file: string, args?: string[], options?: object, callback?: function): ChildProcess
  • Parameters

    • file: string
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

execFileSync

  • execFileSync(command: string, args?: string[], options?: object): string | Buffer
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns string | Buffer

execSync

  • execSync(command: string, options?: object): string | Buffer
  • Parameters

    • command: string
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns string | Buffer

fork

  • fork(modulePath: string, args?: string[], options?: object): ChildProcess
  • Parameters

    • modulePath: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any

    Returns ChildProcess

spawn

  • spawn(command: string, args?: string[], options?: object): ChildProcess
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional custom?: any
      • Optional cwd?: string
      • Optional detached?: boolean
      • Optional env?: any
      • Optional stdio?: any

    Returns ChildProcess

spawnSync

  • spawnSync(command: string, args?: string[], options?: object): object
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns object

    • error: Error
    • output: string[]
    • pid: number
    • signal: string
    • status: number
    • stderr: string | Buffer
    • stdout: string | Buffer

"clone"

"clone":

See clone JS source for API docs

clone

  • clone<T>(val: T, circular?: boolean, depth?: number): T
  • Type parameters

    • T

    Parameters

    • val: T

      the value that you want to clone, any type allowed

    • Optional circular: boolean

      Call clone with circular set to false if you are certain that obj contains no circular references. This will give better performance if needed. There is no error if undefined or null is passed as obj.

    • Optional depth: number

      to wich the object is to be cloned (optional, defaults to infinity)

    Returns T

clonePrototype

  • clonePrototype<T>(obj: T): T
  • Type parameters

    • T

    Parameters

    • obj: T

      the object that you want to clone

    Returns T

"cluster"

"cluster":

Worker

Worker:

id

id: string

process

process: ChildProcess

suicide

suicide: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

destroy

  • destroy(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

kill

  • kill(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ClusterSettings

ClusterSettings:

args

args: string[]

exec

exec: string

silent

silent: boolean

isMaster

isMaster: boolean

isWorker

isWorker: boolean

settings

settings: ClusterSettings

worker

worker: Worker

workers

workers: Worker[]

addListener

  • addListener(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

disconnect

  • disconnect(callback?: Function): void
  • Parameters

    • Optional callback: Function

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

fork

  • Parameters

    • Optional env: any

    Returns Worker

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • on(event: string, listener: Function): any
  • Parameters

    • event: string
    • listener: Function

    Returns any

once

  • once(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): void
  • Parameters

    • Optional event: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void
  • Parameters

    • n: number

    Returns void

setupMaster

  • Parameters

    Returns void

"constants"

"constants":

DH_CHECK_P_NOT_PRIME

DH_CHECK_P_NOT_PRIME: number

DH_CHECK_P_NOT_SAFE_PRIME

DH_CHECK_P_NOT_SAFE_PRIME: number

DH_NOT_SUITABLE_GENERATOR

DH_NOT_SUITABLE_GENERATOR: number

DH_UNABLE_TO_CHECK_GENERATOR

DH_UNABLE_TO_CHECK_GENERATOR: number

E2BIG

E2BIG: number

EACCES

EACCES: number

EADDRINUSE

EADDRINUSE: number

EADDRNOTAVAIL

EADDRNOTAVAIL: number

EAFNOSUPPORT

EAFNOSUPPORT: number

EAGAIN

EAGAIN: number

EALREADY

EALREADY: number

EBADF

EBADF: number

EBADMSG

EBADMSG: number

EBUSY

EBUSY: number

ECANCELED

ECANCELED: number

ECHILD

ECHILD: number

ECONNABORTED

ECONNABORTED: number

ECONNREFUSED

ECONNREFUSED: number

ECONNRESET

ECONNRESET: number

EDEADLK

EDEADLK: number

EDESTADDRREQ

EDESTADDRREQ: number

EDOM

EDOM: number

EEXIST

EEXIST: number

EFAULT

EFAULT: number

EFBIG

EFBIG: number

EHOSTUNREACH

EHOSTUNREACH: number

EIDRM

EIDRM: number

EILSEQ

EILSEQ: number

EINPROGRESS

EINPROGRESS: number

EINTR

EINTR: number

EINVAL

EINVAL: number

EIO

EIO: number

EISCONN

EISCONN: number

EISDIR

EISDIR: number

ELOOP

ELOOP: number

EMFILE

EMFILE: number

EMLINK

EMLINK: number

EMSGSIZE

EMSGSIZE: number

ENAMETOOLONG

ENAMETOOLONG: number

ENETDOWN

ENETDOWN: number

ENETRESET

ENETRESET: number

ENETUNREACH

ENETUNREACH: number

ENFILE

ENFILE: number

ENGINE_METHOD_ALL

ENGINE_METHOD_ALL: number

ENGINE_METHOD_CIPHERS

ENGINE_METHOD_CIPHERS: number

ENGINE_METHOD_DH

ENGINE_METHOD_DH: number

ENGINE_METHOD_DIGESTS

ENGINE_METHOD_DIGESTS: number

ENGINE_METHOD_DSA

ENGINE_METHOD_DSA: number

ENGINE_METHOD_ECDH

ENGINE_METHOD_ECDH: number

ENGINE_METHOD_ECDSA

ENGINE_METHOD_ECDSA: number

ENGINE_METHOD_NONE

ENGINE_METHOD_NONE: number

ENGINE_METHOD_PKEY_ASN1_METHS

ENGINE_METHOD_PKEY_ASN1_METHS: number

ENGINE_METHOD_PKEY_METHS

ENGINE_METHOD_PKEY_METHS: number

ENGINE_METHOD_RAND

ENGINE_METHOD_RAND: number

ENGINE_METHOD_STORE

ENGINE_METHOD_STORE: number

ENOBUFS

ENOBUFS: number

ENODATA

ENODATA: number

ENODEV

ENODEV: number

ENOENT

ENOENT: number

ENOEXEC

ENOEXEC: number

ENOLCK

ENOLCK: number

ENOLINK

ENOLINK: number

ENOMEM

ENOMEM: number

ENOMSG

ENOMSG: number

ENOPROTOOPT

ENOPROTOOPT: number

ENOSPC

ENOSPC: number

ENOSR

ENOSR: number

ENOSTR

ENOSTR: number

ENOSYS

ENOSYS: number

ENOTCONN

ENOTCONN: number

ENOTDIR

ENOTDIR: number

ENOTEMPTY

ENOTEMPTY: number

ENOTSOCK

ENOTSOCK: number

ENOTSUP

ENOTSUP: number

ENOTTY

ENOTTY: number

ENXIO

ENXIO: number

EOPNOTSUPP

EOPNOTSUPP: number

EOVERFLOW

EOVERFLOW: number

EPERM

EPERM: number

EPIPE

EPIPE: number

EPROTO

EPROTO: number

EPROTONOSUPPORT

EPROTONOSUPPORT: number

EPROTOTYPE

EPROTOTYPE: number

ERANGE

ERANGE: number

EROFS

EROFS: number

ESPIPE

ESPIPE: number

ESRCH

ESRCH: number

ETIME

ETIME: number

ETIMEDOUT

ETIMEDOUT: number

ETXTBSY

ETXTBSY: number

EWOULDBLOCK

EWOULDBLOCK: number

EXDEV

EXDEV: number

F_OK

F_OK: number

NPN_ENABLED

NPN_ENABLED: number

O_APPEND

O_APPEND: number

O_CREAT

O_CREAT: number

O_EXCL

O_EXCL: number

O_RDONLY

O_RDONLY: number

O_RDWR

O_RDWR: number

O_TRUNC

O_TRUNC: number

O_WRONLY

O_WRONLY: number

POINT_CONVERSION_COMPRESSED

POINT_CONVERSION_COMPRESSED: number

POINT_CONVERSION_HYBRID

POINT_CONVERSION_HYBRID: number

POINT_CONVERSION_UNCOMPRESSED

POINT_CONVERSION_UNCOMPRESSED: number

RSA_NO_PADDING

RSA_NO_PADDING: number

RSA_PKCS1_OAEP_PADDING

RSA_PKCS1_OAEP_PADDING: number

RSA_PKCS1_PADDING

RSA_PKCS1_PADDING: number

RSA_PKCS1_PSS_PADDING

RSA_PKCS1_PSS_PADDING: number

RSA_SSLV23_PADDING

RSA_SSLV23_PADDING: number

RSA_X931_PADDING

RSA_X931_PADDING: number

R_OK

R_OK: number

SIGABRT

SIGABRT: number

SIGBREAK

SIGBREAK: number

SIGFPE

SIGFPE: number

SIGHUP

SIGHUP: number

SIGILL

SIGILL: number

SIGINT

SIGINT: number

SIGKILL

SIGKILL: number

SIGSEGV

SIGSEGV: number

SIGTERM

SIGTERM: number

SIGWINCH

SIGWINCH: number

SSL_OP_ALL

SSL_OP_ALL: number

SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION

SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number

SSL_OP_CIPHER_SERVER_PREFERENCE

SSL_OP_CIPHER_SERVER_PREFERENCE: number

SSL_OP_CISCO_ANYCONNECT

SSL_OP_CISCO_ANYCONNECT: number

SSL_OP_COOKIE_EXCHANGE

SSL_OP_COOKIE_EXCHANGE: number

SSL_OP_CRYPTOPRO_TLSEXT_BUG

SSL_OP_CRYPTOPRO_TLSEXT_BUG: number

SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS

SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number

SSL_OP_EPHEMERAL_RSA

SSL_OP_EPHEMERAL_RSA: number

SSL_OP_LEGACY_SERVER_CONNECT

SSL_OP_LEGACY_SERVER_CONNECT: number

SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER

SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number

SSL_OP_MICROSOFT_SESS_ID_BUG

SSL_OP_MICROSOFT_SESS_ID_BUG: number

SSL_OP_MSIE_SSLV2_RSA_PADDING

SSL_OP_MSIE_SSLV2_RSA_PADDING: number

SSL_OP_NETSCAPE_CA_DN_BUG

SSL_OP_NETSCAPE_CA_DN_BUG: number

SSL_OP_NETSCAPE_CHALLENGE_BUG

SSL_OP_NETSCAPE_CHALLENGE_BUG: number

SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG

SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number

SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG

SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number

SSL_OP_NO_COMPRESSION

SSL_OP_NO_COMPRESSION: number

SSL_OP_NO_QUERY_MTU

SSL_OP_NO_QUERY_MTU: number

SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION

SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number

SSL_OP_NO_SSLv2

SSL_OP_NO_SSLv2: number

SSL_OP_NO_SSLv3

SSL_OP_NO_SSLv3: number

SSL_OP_NO_TICKET

SSL_OP_NO_TICKET: number

SSL_OP_NO_TLSv1

SSL_OP_NO_TLSv1: number

SSL_OP_NO_TLSv1_1

SSL_OP_NO_TLSv1_1: number

SSL_OP_NO_TLSv1_2

SSL_OP_NO_TLSv1_2: number

SSL_OP_PKCS1_CHECK_1

SSL_OP_PKCS1_CHECK_1: number

SSL_OP_PKCS1_CHECK_2

SSL_OP_PKCS1_CHECK_2: number

SSL_OP_SINGLE_DH_USE

SSL_OP_SINGLE_DH_USE: number

SSL_OP_SINGLE_ECDH_USE

SSL_OP_SINGLE_ECDH_USE: number

SSL_OP_SSLEAY_080_CLIENT_DH_BUG

SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number

SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG

SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number

SSL_OP_TLS_BLOCK_PADDING_BUG

SSL_OP_TLS_BLOCK_PADDING_BUG: number

SSL_OP_TLS_D5_BUG

SSL_OP_TLS_D5_BUG: number

SSL_OP_TLS_ROLLBACK_BUG

SSL_OP_TLS_ROLLBACK_BUG: number

S_IFCHR

S_IFCHR: number

S_IFDIR

S_IFDIR: number

S_IFLNK

S_IFLNK: number

S_IFMT

S_IFMT: number

S_IFREG

S_IFREG: number

UV_UDP_REUSEADDR

UV_UDP_REUSEADDR: number

WSAEACCES

WSAEACCES: number

WSAEADDRINUSE

WSAEADDRINUSE: number

WSAEADDRNOTAVAIL

WSAEADDRNOTAVAIL: number

WSAEAFNOSUPPORT

WSAEAFNOSUPPORT: number

WSAEALREADY

WSAEALREADY: number

WSAEBADF

WSAEBADF: number

WSAECANCELLED

WSAECANCELLED: number

WSAECONNABORTED

WSAECONNABORTED: number

WSAECONNREFUSED

WSAECONNREFUSED: number

WSAECONNRESET

WSAECONNRESET: number

WSAEDESTADDRREQ

WSAEDESTADDRREQ: number

WSAEDISCON

WSAEDISCON: number

WSAEDQUOT

WSAEDQUOT: number

WSAEFAULT

WSAEFAULT: number

WSAEHOSTDOWN

WSAEHOSTDOWN: number

WSAEHOSTUNREACH

WSAEHOSTUNREACH: number

WSAEINPROGRESS

WSAEINPROGRESS: number

WSAEINTR

WSAEINTR: number

WSAEINVAL

WSAEINVAL: number

WSAEINVALIDPROCTABLE

WSAEINVALIDPROCTABLE: number

WSAEINVALIDPROVIDER

WSAEINVALIDPROVIDER: number

WSAEISCONN

WSAEISCONN: number

WSAELOOP

WSAELOOP: number

WSAEMFILE

WSAEMFILE: number

WSAEMSGSIZE

WSAEMSGSIZE: number

WSAENAMETOOLONG

WSAENAMETOOLONG: number

WSAENETDOWN

WSAENETDOWN: number

WSAENETRESET

WSAENETRESET: number

WSAENETUNREACH

WSAENETUNREACH: number

WSAENOBUFS

WSAENOBUFS: number

WSAENOMORE

WSAENOMORE: number

WSAENOPROTOOPT

WSAENOPROTOOPT: number

WSAENOTCONN

WSAENOTCONN: number

WSAENOTEMPTY

WSAENOTEMPTY: number

WSAENOTSOCK

WSAENOTSOCK: number

WSAEOPNOTSUPP

WSAEOPNOTSUPP: number

WSAEPFNOSUPPORT

WSAEPFNOSUPPORT: number

WSAEPROCLIM

WSAEPROCLIM: number

WSAEPROTONOSUPPORT

WSAEPROTONOSUPPORT: number

WSAEPROTOTYPE

WSAEPROTOTYPE: number

WSAEPROVIDERFAILEDINIT

WSAEPROVIDERFAILEDINIT: number

WSAEREFUSED

WSAEREFUSED: number

WSAEREMOTE

WSAEREMOTE: number

WSAESHUTDOWN

WSAESHUTDOWN: number

WSAESOCKTNOSUPPORT

WSAESOCKTNOSUPPORT: number

WSAESTALE

WSAESTALE: number

WSAETIMEDOUT

WSAETIMEDOUT: number

WSAETOOMANYREFS

WSAETOOMANYREFS: number

WSAEUSERS

WSAEUSERS: number

WSAEWOULDBLOCK

WSAEWOULDBLOCK: number

WSANOTINITIALISED

WSANOTINITIALISED: number

WSASERVICE_NOT_FOUND

WSASERVICE_NOT_FOUND: number

WSASYSCALLFAILURE

WSASYSCALLFAILURE: number

WSASYSNOTREADY

WSASYSNOTREADY: number

WSATYPE_NOT_FOUND

WSATYPE_NOT_FOUND: number

WSAVERNOTSUPPORTED

WSAVERNOTSUPPORTED: number

WSA_E_CANCELLED

WSA_E_CANCELLED: number

WSA_E_NO_MORE

WSA_E_NO_MORE: number

W_OK

W_OK: number

X_OK

X_OK: number

"crypto"

"crypto":

Cipher

Cipher:

final

  • final(): Buffer
  • final(output_encoding: string): string
  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void
  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

CredentialDetails

CredentialDetails:

ca

ca: any

cert

cert: string

ciphers

ciphers: string

crl

crl: any

key

key: string

passphrase

passphrase: string

pfx

pfx: string

Credentials

Credentials:

context

context: any

Decipher

Decipher:

final

  • final(): Buffer
  • final(output_encoding: string): string
  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void
  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

DiffieHellman

DiffieHellman:

computeSecret

  • computeSecret(other_public_key: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    • other_public_key: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

generateKeys

  • generateKeys(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getGenerator

  • getGenerator(encoding: string): string
  • Parameters

    • encoding: string

    Returns string

getPrime

  • getPrime(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getPrivateKey

  • getPrivateKey(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getPublicKey

  • getPublicKey(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

setPrivateKey

  • setPrivateKey(public_key: string, encoding?: string): void
  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

setPublicKey

  • setPublicKey(public_key: string, encoding?: string): void
  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

Hash

Hash:

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer
  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

update

  • update(data: any, input_encoding?: string): Hash
  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hash

Hmac

Hmac:

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer
  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

update

  • update(data: any, input_encoding?: string): Hmac
  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hmac

Signer

Signer:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

sign

  • sign(private_key: string, output_format: string): string
  • Parameters

    • private_key: string
    • output_format: string

    Returns string

update

  • update(data: any): void
  • Parameters

    • data: any

    Returns void

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Verify

Verify:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

update

  • update(data: any): void
  • Parameters

    • data: any

    Returns void

verify

  • verify(object: string, signature: string, signature_format?: string): boolean
  • Parameters

    • object: string
    • signature: string
    • Optional signature_format: string

    Returns boolean

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

createCipher

  • createCipher(algorithm: string, password: any): Cipher
  • Parameters

    • algorithm: string
    • password: any

    Returns Cipher

createCipheriv

  • createCipheriv(algorithm: string, key: any, iv: any): Cipher
  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Cipher

createCredentials

createDecipher

  • createDecipher(algorithm: string, password: any): Decipher
  • Parameters

    • algorithm: string
    • password: any

    Returns Decipher

createDecipheriv

  • createDecipheriv(algorithm: string, key: any, iv: any): Decipher
  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Decipher

createDiffieHellman

  • Parameters

    • prime_length: number

    Returns DiffieHellman

  • Parameters

    • prime: number
    • Optional encoding: string

    Returns DiffieHellman

createHash

  • createHash(algorithm: string): Hash
  • Parameters

    • algorithm: string

    Returns Hash

createHmac

  • createHmac(algorithm: string, key: string): Hmac
  • createHmac(algorithm: string, key: Buffer): Hmac
  • Parameters

    • algorithm: string
    • key: string

    Returns Hmac

  • Parameters

    • algorithm: string
    • key: Buffer

    Returns Hmac

createSign

  • createSign(algorithm: string): Signer
  • Parameters

    • algorithm: string

    Returns Signer

createVerify

  • createVerify(algorith: string): Verify
  • Parameters

    • algorith: string

    Returns Verify

getDiffieHellman

  • Parameters

    • group_name: string

    Returns DiffieHellman

pbkdf2

  • pbkdf2(password: string, salt: string, iterations: number, keylen: number, callback: function): void
  • pbkdf2(password: string, salt: string, iterations: number, keylen: number, digest: string, callback: function): void
  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number
    • callback: function
        • (err: Error, derivedKey: Buffer): any
        • Parameters

          • err: Error
          • derivedKey: Buffer

          Returns any

    Returns void

  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number
    • digest: string
    • callback: function
        • (err: Error, derivedKey: Buffer): any
        • Parameters

          • err: Error
          • derivedKey: Buffer

          Returns any

    Returns void

pbkdf2Sync

  • pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number): Buffer
  • pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number, digest: string): Buffer
  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number

    Returns Buffer

  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number
    • digest: string

    Returns Buffer

pseudoRandomBytes

  • pseudoRandomBytes(size: number): Buffer
  • pseudoRandomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void
        • Parameters

          Returns void

    Returns void

randomBytes

  • randomBytes(size: number): Buffer
  • randomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void
        • Parameters

          Returns void

    Returns void

"dgram"

"dgram":

AddressInfo

AddressInfo:

address

address: string

family

family: string

port

port: number

RemoteInfo

RemoteInfo:

address

address: string

port

port: number

size

size: number

Socket

Socket:

addListener

  • addListener(event: string, listener: Function): EventEmitter

addMembership

  • addMembership(multicastAddress: string, multicastInterface?: string): void
  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

address

  • Returns AddressInfo

bind

  • bind(port: number, address?: string, callback?: function): void
  • Parameters

    • port: number
    • Optional address: string
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

close

  • close(): void
  • Returns void

dropMembership

  • dropMembership(multicastAddress: string, multicastInterface?: string): void
  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(buf: Buffer, offset: number, length: number, port: number, address: string, callback?: function): void
  • Parameters

    • buf: Buffer
    • offset: number
    • length: number
    • port: number
    • address: string
    • Optional callback: function
        • (error: Error, bytes: number): void
        • Parameters

          • error: Error
          • bytes: number

          Returns void

    Returns void

setBroadcast

  • setBroadcast(flag: boolean): void
  • Parameters

    • flag: boolean

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setMulticastLoopback

  • setMulticastLoopback(flag: boolean): void
  • Parameters

    • flag: boolean

    Returns void

setMulticastTTL

  • setMulticastTTL(ttl: number): void
  • Parameters

    • ttl: number

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

createSocket

  • createSocket(type: string, callback?: function): Socket
  • Parameters

    Returns Socket

"dns"

"dns":

lookup

  • lookup(domain: string, family: number, callback: function): string
  • lookup(domain: string, callback: function): string
  • Parameters

    • domain: string
    • family: number
    • callback: function
        • (err: Error, address: string, family: number): void
        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, address: string, family: number): void
        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

resolve

  • resolve(domain: string, rrtype: string, callback: function): string[]
  • resolve(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • rrtype: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve4

  • resolve4(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve6

  • resolve6(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveCname

  • resolveCname(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveMx

  • resolveMx(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveNs

  • resolveNs(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveSrv

  • resolveSrv(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveTxt

  • resolveTxt(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

reverse

  • reverse(ip: string, callback: function): string[]
  • Parameters

    • ip: string
    • callback: function
        • (err: Error, domains: string[]): void
        • Parameters

          • err: Error
          • domains: string[]

          Returns void

    Returns string[]

"domain"

"domain":

Domain

Domain:

add

  • Parameters

    Returns void

addListener

  • addListener(event: string, listener: Function): Domain

bind

  • bind(cb: function): any
  • Parameters

    • cb: function
        • (err: Error, data: any): any
        • Parameters

          • err: Error
          • data: any

          Returns any

    Returns any

dispose

  • dispose(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

intercept

  • intercept(cb: function): any
  • Parameters

    • cb: function
        • (data: any): any
        • Parameters

          • data: any

          Returns any

    Returns any

listeners

  • listeners(event: string): Function[]

on

  • on(event: string, listener: Function): Domain

once

  • once(event: string, listener: Function): Domain

remove

  • Parameters

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): Domain

removeListener

  • removeListener(event: string, listener: Function): Domain

run

  • run(fn: Function): void
  • Parameters

    • fn: Function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

create

  • Returns Domain

"enum"

"enum":

Enum

Enum:

enums

enums: EnumValue[]

get

  • Parameters

    • value: number | string

    Returns EnumValue

"es6-collections"

"es6-collections":

Map

Map: MapConstructor

Set

Set: SetConstructor

WeakMap

WeakMap: WeakMapConstructor

WeakSet

WeakSet: WeakSetConstructor

"es6-promise"

"es6-promise":

rsvp

rsvp:

Promise

Promise: Promise

foo

foo: Promise

"events"

"events":

EventEmitter

EventEmitter:

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number
  • Parameters

    Returns number

"fs"

"fs":

FSWatcher

FSWatcher:

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ReadStream

ReadStream:

constructor

readable

readable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Stats

Stats:

atime

atime: Date

birthtime

birthtime: Date

blksize

blksize: number

blocks

blocks: number

ctime

ctime: Date

dev

dev: number

gid

gid: number

ino

ino: number

mode

mode: number

mtime

mtime: Date

nlink

nlink: number

rdev

rdev: number

size

size: number

uid

uid: number

isBlockDevice

  • isBlockDevice(): boolean
  • Returns boolean

isCharacterDevice

  • isCharacterDevice(): boolean
  • Returns boolean

isDirectory

  • isDirectory(): boolean
  • Returns boolean

isFIFO

  • isFIFO(): boolean
  • Returns boolean

isFile

  • isFile(): boolean
  • Returns boolean

isSocket

  • isSocket(): boolean
  • Returns boolean

isSymbolicLink

  • isSymbolicLink(): boolean
  • Returns boolean

WriteStream

WriteStream:

constructor

bytesWritten

bytesWritten: number

writable

writable: boolean

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

F_OK

F_OK: number

Constant for fs.access(). File is visible to the calling process.

R_OK

R_OK: number

Constant for fs.access(). File can be read by the calling process.

W_OK

W_OK: number

Constant for fs.access(). File can be written by the calling process.

X_OK

X_OK: number

Constant for fs.access(). File can be executed by the calling process.

access

  • access(path: string, callback: function): void
  • access(path: string, mode: number, callback: function): void
  • Tests a user's permissions for the file specified by path.

    Parameters

    Returns void

  • Parameters

    Returns void

accessSync

  • accessSync(path: string, mode?: number): void
  • Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise.

    Parameters

    • path: string
    • Optional mode: number

    Returns void

appendFile

  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, callback?: function): void
  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

appendFileSync

  • appendFileSync(filename: string, data: any, options?: object): void
  • appendFileSync(filename: string, data: any, options?: object): void
  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

chmod

  • chmod(path: string, mode: number, callback?: function): void
  • chmod(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

chmodSync

  • chmodSync(path: string, mode: number): void
  • chmodSync(path: string, mode: string): void
  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

chown

  • chown(path: string, uid: number, gid: number, callback?: function): void
  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

chownSync

  • chownSync(path: string, uid: number, gid: number): void
  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

close

  • close(fd: number, callback?: function): void
  • Parameters

    Returns void

closeSync

  • closeSync(fd: number): void
  • Parameters

    • fd: number

    Returns void

createReadStream

  • createReadStream(path: string, options?: object): ReadStream
  • Parameters

    • path: string
    • Optional options: object
      • Optional autoClose?: boolean
      • Optional encoding?: string
      • Optional fd?: number
      • Optional flags?: string
      • Optional mode?: number

    Returns ReadStream

createWriteStream

  • createWriteStream(path: string, options?: object): WriteStream
  • Parameters

    • path: string
    • Optional options: object
      • Optional encoding?: string
      • Optional fd?: number
      • Optional flags?: string
      • Optional mode?: number

    Returns WriteStream

exists

  • exists(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function
        • (exists: boolean): void
        • Parameters

          • exists: boolean

          Returns void

    Returns void

existsSync

  • existsSync(path: string): boolean
  • Parameters

    • path: string

    Returns boolean

fchmod

  • fchmod(fd: number, mode: number, callback?: function): void
  • fchmod(fd: number, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

fchmodSync

  • fchmodSync(fd: number, mode: number): void
  • fchmodSync(fd: number, mode: string): void
  • Parameters

    • fd: number
    • mode: number

    Returns void

  • Parameters

    • fd: number
    • mode: string

    Returns void

fchown

  • fchown(fd: number, uid: number, gid: number, callback?: function): void
  • Parameters

    • fd: number
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

fchownSync

  • fchownSync(fd: number, uid: number, gid: number): void
  • Parameters

    • fd: number
    • uid: number
    • gid: number

    Returns void

fstat

  • fstat(fd: number, callback?: function): void
  • Parameters

    Returns void

fstatSync

  • fstatSync(fd: number): Stats
  • Parameters

    • fd: number

    Returns Stats

fsync

  • fsync(fd: number, callback?: function): void
  • Parameters

    Returns void

fsyncSync

  • fsyncSync(fd: number): void
  • Parameters

    • fd: number

    Returns void

ftruncate

  • ftruncate(fd: number, callback?: function): void
  • ftruncate(fd: number, len: number, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

ftruncateSync

  • ftruncateSync(fd: number, len?: number): void
  • Parameters

    • fd: number
    • Optional len: number

    Returns void

futimes

  • futimes(fd: number, atime: number, mtime: number, callback?: function): void
  • futimes(fd: number, atime: Date, mtime: Date, callback?: function): void
  • Parameters

    • fd: number
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

futimesSync

  • futimesSync(fd: number, atime: number, mtime: number): void
  • futimesSync(fd: number, atime: Date, mtime: Date): void
  • Parameters

    • fd: number
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date

    Returns void

lchmod

  • lchmod(path: string, mode: number, callback?: function): void
  • lchmod(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

lchmodSync

  • lchmodSync(path: string, mode: number): void
  • lchmodSync(path: string, mode: string): void
  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

lchown

  • lchown(path: string, uid: number, gid: number, callback?: function): void
  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

lchownSync

  • lchownSync(path: string, uid: number, gid: number): void
  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

link

  • link(srcpath: string, dstpath: string, callback?: function): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional callback: function

    Returns void

linkSync

  • linkSync(srcpath: string, dstpath: string): void
  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

lstat

  • lstat(path: string, callback?: function): void
  • Parameters

    Returns void

lstatSync

  • lstatSync(path: string): Stats
  • Parameters

    • path: string

    Returns Stats

mkdir

  • mkdir(path: string, callback?: function): void
  • mkdir(path: string, mode: number, callback?: function): void
  • mkdir(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

mkdirSync

  • mkdirSync(path: string, mode?: number): void
  • mkdirSync(path: string, mode?: string): void
  • Parameters

    • path: string
    • Optional mode: number

    Returns void

  • Parameters

    • path: string
    • Optional mode: string

    Returns void

open

  • open(path: string, flags: string, callback?: function): void
  • open(path: string, flags: string, mode: number, callback?: function): void
  • open(path: string, flags: string, mode: string, callback?: function): void
  • Parameters

    • path: string
    • flags: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: string
    • Optional callback: function

    Returns void

openSync

  • openSync(path: string, flags: string, mode?: number): number
  • openSync(path: string, flags: string, mode?: string): number
  • Parameters

    • path: string
    • flags: string
    • Optional mode: number

    Returns number

  • Parameters

    • path: string
    • flags: string
    • Optional mode: string

    Returns number

read

  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

readFile

  • readFile(filename: string, encoding: string, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, callback: function): void
  • Parameters

    • filename: string
    • encoding: string
    • callback: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string
    • callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

readFileSync

  • readFileSync(filename: string, encoding: string): string
  • readFileSync(filename: string, options: object): string
  • readFileSync(filename: string, options?: object): Buffer
  • Parameters

    • filename: string
    • encoding: string

    Returns string

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string

    Returns string

  • Parameters

    • filename: string
    • Optional options: object
      • Optional flag?: string

    Returns Buffer

readSync

  • readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

readdir

  • readdir(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readdirSync

  • readdirSync(path: string): string[]
  • Parameters

    • path: string

    Returns string[]

readlink

  • readlink(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readlinkSync

  • readlinkSync(path: string): string
  • Parameters

    • path: string

    Returns string

realpath

  • realpath(path: string, callback?: function): void
  • realpath(path: string, cache: object, callback: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • cache: object
      • [path: string]: string
    • callback: function

    Returns void

realpathSync

  • realpathSync(path: string, cache?: object): string
  • Parameters

    • path: string
    • Optional cache: object
      • [path: string]: string

    Returns string

rename

  • rename(oldPath: string, newPath: string, callback?: function): void
  • Asynchronous rename.

    Parameters

    • oldPath: string
    • newPath: string
    • Optional callback: function

      No arguments other than a possible exception are given to the completion callback.

    Returns void

renameSync

  • renameSync(oldPath: string, newPath: string): void
  • Synchronous rename

    Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string, callback?: function): void
  • Parameters

    Returns void

rmdirSync

  • rmdirSync(path: string): void
  • Parameters

    • path: string

    Returns void

stat

  • stat(path: string, callback?: function): void
  • Parameters

    Returns void

statSync

  • statSync(path: string): Stats
  • Parameters

    • path: string

    Returns Stats

symlink

  • symlink(srcpath: string, dstpath: string, type?: string, callback?: function): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string
    • Optional callback: function

    Returns void

symlinkSync

  • symlinkSync(srcpath: string, dstpath: string, type?: string): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string

    Returns void

truncate

  • truncate(path: string, callback?: function): void
  • truncate(path: string, len: number, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

truncateSync

  • truncateSync(path: string, len?: number): void
  • Parameters

    • path: string
    • Optional len: number

    Returns void

unlink

  • unlink(path: string, callback?: function): void
  • Parameters

    Returns void

unlinkSync

  • unlinkSync(path: string): void
  • Parameters

    • path: string

    Returns void

unwatchFile

  • unwatchFile(filename: string, listener?: function): void
  • Parameters

    • filename: string
    • Optional listener: function

    Returns void

utimes

  • utimes(path: string, atime: number, mtime: number, callback?: function): void
  • utimes(path: string, atime: Date, mtime: Date, callback?: function): void
  • Parameters

    • path: string
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

utimesSync

  • utimesSync(path: string, atime: number, mtime: number): void
  • utimesSync(path: string, atime: Date, mtime: Date): void
  • Parameters

    • path: string
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date

    Returns void

watch

  • watch(filename: string, listener?: function): FSWatcher
  • watch(filename: string, options: object, listener?: function): FSWatcher
  • Parameters

    • filename: string
    • Optional listener: function
        • (event: string, filename: string): any
        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

  • Parameters

    • filename: string
    • options: object
      • Optional persistent?: boolean
    • Optional listener: function
        • (event: string, filename: string): any
        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

watchFile

  • watchFile(filename: string, listener: function): void
  • watchFile(filename: string, options: object, listener: function): void
  • Parameters

    • filename: string
    • listener: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • Optional interval?: number
      • Optional persistent?: boolean
    • listener: function

    Returns void

write

  • write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void
  • write(fd: number, buffer: Buffer, offset: number, length: number, callback?: function): void
  • write(fd: number, data: any, callback?: function): void
  • write(fd: number, data: any, offset: number, callback?: function): void
  • write(fd: number, data: any, offset: number, encoding: string, callback?: function): void
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • data: any
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • encoding: string
    • Optional callback: function

    Returns void

writeFile

  • writeFile(filename: string, data: any, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

writeFileSync

  • writeFileSync(filename: string, data: any, options?: object): void
  • writeFileSync(filename: string, data: any, options?: object): void
  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

writeSync

  • writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

"gulp-mocha"

"gulp-mocha":

mocha

"http"

"http":

Agent

Agent:

constructor

  • Parameters

    Returns Agent

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

destroy

  • destroy(): void
  • Destroy any sockets that are currently in use by the agent. It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.

    Returns void

AgentOptions

AgentOptions:

keepAlive

keepAlive: boolean

Keep sockets around in a pool to be used by other requests in the future. Default = false

keepAliveMsecs

keepAliveMsecs: number

When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

maxFreeSockets

maxFreeSockets: number

Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

maxSockets

maxSockets: number

Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

ClientRequest

ClientRequest:

constructor

writable

writable: boolean

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setSocketKeepAlive

  • setSocketKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ClientResponse

ClientResponse:
deprecated

Use IncomingMessage

constructor

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

IncomingMessage

IncomingMessage:

constructor

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Server

Server:

maxHeadersCount

maxHeadersCount: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Parameters

    • Optional cb: any

    Returns Server

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listen

  • listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server
  • listen(port: number, hostname?: string, callback?: Function): Server
  • listen(path: string, callback?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • Parameters

    • port: number
    • Optional hostname: string
    • Optional backlog: number
    • Optional callback: Function

    Returns Server

  • Parameters

    • port: number
    • Optional hostname: string
    • Optional callback: Function

    Returns Server

  • Parameters

    • path: string
    • Optional callback: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerRequest

ServerRequest:
deprecated

Use IncomingMessage

constructor

connection

connection: Socket

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerResponse

ServerResponse:

constructor

sendDate

sendDate: boolean

statusCode

statusCode: number

statusMessage

statusMessage: string

writable

writable: boolean

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

addTrailers

  • addTrailers(headers: any): void
  • Parameters

    • headers: any

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getHeader

  • getHeader(name: string): string
  • Parameters

    • name: string

    Returns string

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeHeader

  • removeHeader(name: string): void
  • Parameters

    • name: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setHeader

  • setHeader(name: string, value: string): void
  • Parameters

    • name: string
    • value: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): any
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns any

writeContinue

  • writeContinue(): void
  • Returns void

writeHead

  • writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void
  • writeHead(statusCode: number, headers?: any): void
  • Parameters

    • statusCode: number
    • Optional reasonPhrase: string
    • Optional headers: any

    Returns void

  • Parameters

    • statusCode: number
    • Optional headers: any

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

METHODS

METHODS: string[]

STATUS_CODES

STATUS_CODES: object

Type declaration

  • [errorCode: string]: string

globalAgent

globalAgent: Agent

createClient

  • createClient(port?: number, host?: string): any
  • Parameters

    • Optional port: number
    • Optional host: string

    Returns any

createServer

  • createServer(requestListener?: function): Server

get

request

"https"

"https":

Agent

Agent:

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

RequestOptions

RequestOptions:

agent

agent: any

auth

auth: string

ca

ca: any

cert

cert: any

ciphers

ciphers: string

headers

headers: any

host

host: string

hostname

hostname: string

key

key: any

method

method: string

passphrase

passphrase: string

path

path: string

pfx

pfx: any

port

port: number

rejectUnauthorized

rejectUnauthorized: boolean

Server

Server:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void
  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerOptions

ServerOptions:

NPNProtocols

NPNProtocols: any

SNICallback

SNICallback: function

Type declaration

    • (servername: string): any
    • Parameters

      • servername: string

      Returns any

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: boolean

key

key: any

passphrase

passphrase: string

pfx

pfx: any

rejectUnauthorized

rejectUnauthorized: boolean

requestCert

requestCert: boolean

globalAgent

globalAgent: Agent

createServer

  • Parameters

    Returns Server

get

request

"mocha"

"mocha":

"net"

"net":

Server

Server:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • close(callback?: Function): Server
  • Parameters

    • Optional callback: Function

    Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Socket

Socket:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding?: string): void
  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

connect

  • connect(options: object, connectionListener?: Function): Socket
  • connect(port: number, host?: string, connectionListener?: Function): Socket
  • connect(path: string, connectionListener?: Function): Socket
  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createConnection

  • createConnection(options: object, connectionListener?: Function): Socket
  • createConnection(port: number, host?: string, connectionListener?: Function): Socket
  • createConnection(path: string, connectionListener?: Function): Socket
  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createServer

  • createServer(connectionListener?: function): Server
  • createServer(options?: object, connectionListener?: function): Server
  • Parameters

    • Optional connectionListener: function
        • Parameters

          Returns void

    Returns Server

  • Parameters

    • Optional options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: function
        • Parameters

          Returns void

    Returns Server

isIP

  • isIP(input: string): number
  • Parameters

    • input: string

    Returns number

isIPv4

  • isIPv4(input: string): boolean
  • Parameters

    • input: string

    Returns boolean

isIPv6

  • isIPv6(input: string): boolean
  • Parameters

    • input: string

    Returns boolean

"os"

"os":

EOL

EOL: string

arch

  • arch(): string
  • Returns string

cpus

  • cpus(): object[]
  • Returns object[]

    • model: string
    • speed: number
    • times: object
      • idle: number
      • irq: number
      • nice: number
      • sys: number
      • user: number

freemem

  • freemem(): number
  • Returns number

hostname

  • hostname(): string
  • Returns string

loadavg

  • loadavg(): number[]
  • Returns number[]

networkInterfaces

  • networkInterfaces(): any
  • Returns any

platform

  • platform(): string
  • Returns string

release

  • release(): string
  • Returns string

tmpdir

  • tmpdir(): string
  • Returns string

totalmem

  • totalmem(): number
  • Returns number

type

  • type(): string
  • Returns string

uptime

  • uptime(): number
  • Returns number

"path"

"path":

posix

posix:

delimiter

delimiter: string

sep

sep: string

basename

  • basename(p: string, ext?: string): string
  • Parameters

    • p: string
    • Optional ext: string

    Returns string

dirname

  • dirname(p: string): string
  • Parameters

    • p: string

    Returns string

extname

  • extname(p: string): string
  • Parameters

    • p: string

    Returns string

format

  • Parameters

    Returns string

isAbsolute

  • isAbsolute(p: string): boolean
  • Parameters

    • p: string

    Returns boolean

join

  • join(...paths: any[]): string
  • Parameters

    • Rest ...paths: any[]

    Returns string

normalize

  • normalize(p: string): string
  • Parameters

    • p: string

    Returns string

parse

  • Parameters

    • p: string

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • Parameters

    • Rest ...pathSegments: any[]

    Returns string

win32

win32:

delimiter

delimiter: string

sep

sep: string

basename

  • basename(p: string, ext?: string): string
  • Parameters

    • p: string
    • Optional ext: string

    Returns string

dirname

  • dirname(p: string): string
  • Parameters

    • p: string

    Returns string

extname

  • extname(p: string): string
  • Parameters

    • p: string

    Returns string

format

  • Parameters

    Returns string

isAbsolute

  • isAbsolute(p: string): boolean
  • Parameters

    • p: string

    Returns boolean

join

  • join(...paths: any[]): string
  • Parameters

    • Rest ...paths: any[]

    Returns string

normalize

  • normalize(p: string): string
  • Parameters

    • p: string

    Returns string

parse

  • Parameters

    • p: string

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • Parameters

    • Rest ...pathSegments: any[]

    Returns string

ParsedPath

ParsedPath:

A parsed path object generated by path.parse() or consumed by path.format().

base

base: string

The file name including extension (if any) such as 'index.html'

dir

dir: string

The full directory path such as '/home/user/dir' or 'c:\path\dir'

ext

ext: string

The file extension (if any) such as '.html'

name

name: string

The file name without extension (if any) such as 'index'

root

root: string

The root of the path such as '/' or 'c:\'

delimiter

delimiter: string

The platform-specific file delimiter. ';' or ':'.

sep

sep: string

The platform-specific file separator. '\' or '/'.

basename

  • basename(p: string, ext?: string): string
  • Return the last portion of a path. Similar to the Unix basename command. Often used to extract the file name from a fully qualified path.

    Parameters

    • p: string

      the path to evaluate.

    • Optional ext: string

      optionally, an extension to remove from the result.

    Returns string

dirname

  • dirname(p: string): string
  • Return the directory name of a path. Similar to the Unix dirname command.

    Parameters

    • p: string

      the path to evaluate.

    Returns string

extname

  • extname(p: string): string
  • Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string

    Parameters

    • p: string

      the path to evaluate.

    Returns string

format

  • Returns a path string from an object - the opposite of parse().

    Parameters

    Returns string

isAbsolute

  • isAbsolute(path: string): boolean
  • Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.

    Parameters

    • path: string

      path to test.

    Returns boolean

join

  • join(...paths: any[]): string
  • join(...paths: string[]): string
  • Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

    Parameters

    • Rest ...paths: any[]

      string paths to join.

    Returns string

  • Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

    Parameters

    • Rest ...paths: string[]

      string paths to join.

    Returns string

normalize

  • normalize(p: string): string
  • Normalize a string path, reducing '..' and '.' parts. When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.

    Parameters

    • p: string

      string path to normalize.

    Returns string

parse

  • Returns an object from a path string - the opposite of format().

    Parameters

    • pathString: string

      path to evaluate.

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Solve the relative path from {from} to {to}. At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.

    Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

    Starting from leftmost {from} paramter, resolves {to} to an absolute path.

    If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.

    Parameters

    • Rest ...pathSegments: any[]

      string paths to join. Non-string arguments are ignored.

    Returns string

"punycode"

"punycode":

ucs2

ucs2:

decode

  • decode(string: string): string
  • Parameters

    • string: string

    Returns string

encode

  • encode(codePoints: number[]): string
  • Parameters

    • codePoints: number[]

    Returns string

version

version: any

decode

  • decode(string: string): string
  • Parameters

    • string: string

    Returns string

encode

  • encode(string: string): string
  • Parameters

    • string: string

    Returns string

toASCII

  • toASCII(domain: string): string
  • Parameters

    • domain: string

    Returns string

toUnicode

  • toUnicode(domain: string): string
  • Parameters

    • domain: string

    Returns string

"querystring"

"querystring":

escape

  • escape(str: string): string
  • Parameters

    • str: string

    Returns string

parse

  • parse(str: string, sep?: string, eq?: string, options?: object): any
  • Parameters

    • str: string
    • Optional sep: string
    • Optional eq: string
    • Optional options: object
      • Optional maxKeys?: number

    Returns any

stringify

  • stringify(obj: any, sep?: string, eq?: string): string
  • Parameters

    • obj: any
    • Optional sep: string
    • Optional eq: string

    Returns string

unescape

  • unescape(str: string): string
  • Parameters

    • str: string

    Returns string

"readline"

"readline":

ReadLine

ReadLine:

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

prompt

  • prompt(preserveCursor?: boolean): void
  • Parameters

    • Optional preserveCursor: boolean

    Returns void

question

  • question(query: string, callback: Function): void
  • Parameters

    • query: string
    • callback: Function

    Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setPrompt

  • setPrompt(prompt: string): void
  • Parameters

    • prompt: string

    Returns void

write

  • write(data: any, key?: any): void
  • Parameters

    • data: any
    • Optional key: any

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ReadLineOptions

ReadLineOptions:

completer

completer: Function

input

output

terminal

terminal: boolean

createInterface

"repl"

"repl":

ReplOptions

ReplOptions:

eval

eval: Function

ignoreUndefined

ignoreUndefined: boolean

input

output

prompt

prompt: string

terminal

terminal: boolean

useColors

useColors: boolean

useGlobal

useGlobal: boolean

writer

writer: Function

start

"sqlite3"

"sqlite3":

Database

Database:

constructor

  • new Database(filename: string, callback?: function): Database
  • new Database(filename: string, mode?: number, callback?: function): Database
  • Parameters

    • filename: string
    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Database

  • Parameters

    • filename: string
    • Optional mode: number
    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Database

addListener

  • addListener(event: string, listener: Function): EventEmitter

all

  • all(sql: string, callback?: function, ...params: any[]): Database
  • all(sql: string, ...params: any[]): Database
  • Parameters

    • sql: string
    • Optional callback: function
        • (err: Error, rows: any[]): void
        • Parameters

          • err: Error
          • rows: any[]

          Returns void

    • Rest ...params: any[]

    Returns Database

  • Parameters

    • sql: string
    • Rest ...params: any[]

    Returns Database

close

  • close(callback?: function): void
  • Parameters

    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

each

  • each(sql: string, callback?: function, complete?: function): Database
  • each(sql: string, ...params: any[]): Database
  • Parameters

    • sql: string
    • Optional callback: function
        • (err: Error, row: any): void
        • Parameters

          • err: Error
          • row: any

          Returns void

    • Optional complete: function
        • (err: Error, count: number): void
        • Parameters

          • err: Error
          • count: number

          Returns void

    Returns Database

  • Parameters

    • sql: string
    • Rest ...params: any[]

    Returns Database

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

exec

  • exec(sql: string, callback?: function): Database
  • Parameters

    • sql: string
    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Database

get

  • get(sql: string, callback?: function): Database
  • get(sql: string, ...params: any[]): Database
  • Parameters

    • sql: string
    • Optional callback: function
        • (err: Error, row: any): void
        • Parameters

          • err: Error
          • row: any

          Returns void

    Returns Database

  • Parameters

    • sql: string
    • Rest ...params: any[]

    Returns Database

listeners

  • listeners(event: string): Function[]

on

  • on(event: "trace", listener: function): Database
  • on(event: "profile", listener: function): Database
  • on(event: "error", listener: function): Database
  • on(event: "open", listener: function): Database
  • on(event: "close", listener: function): Database
  • on(event: string, listener: Function): Database
  • Parameters

    • event: "trace"
    • listener: function
        • (sql: string): void
        • Parameters

          • sql: string

          Returns void

    Returns Database

  • Parameters

    • event: "profile"
    • listener: function
        • (sql: string, time: number): void
        • Parameters

          • sql: string
          • time: number

          Returns void

    Returns Database

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Database

  • Parameters

    • event: "open"
    • listener: function
        • (): void
        • Returns void

    Returns Database

  • Parameters

    • event: "close"
    • listener: function
        • (): void
        • Returns void

    Returns Database

  • Parameters

    • event: string
    • listener: Function

    Returns Database

once

parallelize

  • parallelize(callback?: function): void
  • Parameters

    • Optional callback: function
        • (): void
        • Returns void

    Returns void

prepare

  • prepare(sql: string, callback?: function): Statement
  • prepare(sql: string, ...params: any[]): Statement
  • Parameters

    • sql: string
    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Statement

  • Parameters

    • sql: string
    • Rest ...params: any[]

    Returns Statement

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

run

  • run(sql: string, callback?: function): Database
  • run(sql: string, ...params: any[]): Database
  • Parameters

    • sql: string
    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Database

  • Parameters

    • sql: string
    • Rest ...params: any[]

    Returns Database

serialize

  • serialize(callback?: function): void
  • Parameters

    • Optional callback: function
        • (): void
        • Returns void

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Statement

Statement:

all

  • Parameters

    • Optional callback: function
        • (err: Error, rows: any[]): void
        • Parameters

          • err: Error
          • rows: any[]

          Returns void

    Returns Statement

  • Parameters

    • Rest ...params: any[]

    Returns Statement

bind

  • Parameters

    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Statement

  • Parameters

    • Rest ...params: any[]

    Returns Statement

each

  • each(callback?: function, complete?: function): Statement
  • each(...params: any[]): Statement
  • Parameters

    • Optional callback: function
        • (err: Error, row: any): void
        • Parameters

          • err: Error
          • row: any

          Returns void

    • Optional complete: function
        • (err: Error, count: number): void
        • Parameters

          • err: Error
          • count: number

          Returns void

    Returns Statement

  • Parameters

    • Rest ...params: any[]

    Returns Statement

finalize

  • Parameters

    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Statement

get

  • Parameters

    • Optional callback: function
        • (err: Error, row: any): void
        • Parameters

          • err: Error
          • row: any

          Returns void

    Returns Statement

  • Parameters

    • Rest ...params: any[]

    Returns Statement

reset

  • Parameters

    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Statement

run

  • Parameters

    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns Statement

  • Parameters

    • Rest ...params: any[]

    Returns Statement

RunResult

RunResult:

changes

changes: number

lastID

lastID: number

OPEN_CREATE

OPEN_CREATE: number

OPEN_READONLY

OPEN_READONLY: number

OPEN_READWRITE

OPEN_READWRITE: number

cached

cached: object

Type declaration

  • Database: function
    • Database(filename: string, callback?: function): Database
    • Database(filename: string, mode?: number, callback?: function): Database
    • Parameters

      • filename: string
      • Optional callback: function
          • (err: Error): void
          • Parameters

            • err: Error

            Returns void

      Returns Database

    • Parameters

      • filename: string
      • Optional mode: number
      • Optional callback: function
          • (err: Error): void
          • Parameters

            • err: Error

            Returns void

      Returns Database

verbose

  • verbose(): void
  • Returns void

"stream"

"stream":

Duplex

Duplex:

constructor

readable

readable: boolean

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

PassThrough

PassThrough:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Readable

Readable:

constructor

readable

readable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Transform

Transform:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Writable

Writable:

constructor

writable

writable: boolean

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

DuplexOptions

DuplexOptions:

allowHalfOpen

allowHalfOpen: boolean

decodeStrings

decodeStrings: boolean

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

ReadableOptions

ReadableOptions:

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

Stream

Stream:

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

TransformOptions

TransformOptions:

decodeStrings

decodeStrings: boolean

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

WritableOptions

WritableOptions:

decodeStrings

decodeStrings: boolean

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

"string_decoder"

"string_decoder":

NodeStringDecoder

NodeStringDecoder:

detectIncompleteChar

  • detectIncompleteChar(buffer: Buffer): number
  • Parameters

    Returns number

write

  • write(buffer: Buffer): string
  • Parameters

    Returns string

StringDecoder

StringDecoder: object

Type declaration

  • constructor: function
    • new __type(encoding: string): __type
    • Parameters

      • encoding: string

      Returns __type

"tls"

"tls":

ClearTextStream

ClearTextStream:

constructor

address

address: object

Type declaration

  • address: string
  • family: string
  • port: number

authorizationError

authorizationError: Error

authorized

authorized: boolean

getCipher

getCipher: object

Type declaration

  • name: string
  • version: string

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getPeerCertificate

  • getPeerCertificate(): any
  • Returns any

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ConnectionOptions

ConnectionOptions:

NPNProtocols

NPNProtocols: any

ca

ca: any

cert

cert: any

host

host: string

key

key: any

passphrase

passphrase: string

pfx

pfx: any

port

port: number

rejectUnauthorized

rejectUnauthorized: boolean

servername

servername: string

socket

socket: Socket

SecureContext

SecureContext:

context

context: any

SecureContextOptions

SecureContextOptions:

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: boolean

key

key: any

passphrase

passphrase: string

pfx

pfx: any

SecurePair

SecurePair:

cleartext

cleartext: any

encrypted

encrypted: any

Server

Server:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void
  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

TlsOptions

TlsOptions:

NPNProtocols

NPNProtocols: any

SNICallback

SNICallback: function

Type declaration

    • (servername: string): any
    • Parameters

      • servername: string

      Returns any

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: any

key

key: any

passphrase

passphrase: string

pfx

pfx: any

rejectUnauthorized

rejectUnauthorized: boolean

requestCert

requestCert: boolean

CLIENT_RENEG_LIMIT

CLIENT_RENEG_LIMIT: number

CLIENT_RENEG_WINDOW

CLIENT_RENEG_WINDOW: number

connect

  • Parameters

    • options: TlsOptions
    • Optional secureConnectionListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional host: string
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

createSecureContext

createSecurePair

  • createSecurePair(credentials?: Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair
  • Parameters

    • Optional credentials: Credentials
    • Optional isServer: boolean
    • Optional requestCert: boolean
    • Optional rejectUnauthorized: boolean

    Returns SecurePair

createServer

  • createServer(options: TlsOptions, secureConnectionListener?: function): Server

"tty"

"tty":

ReadStream

ReadStream:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

isRaw

isRaw: boolean

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setRawMode

  • setRawMode(mode: boolean): void
  • Parameters

    • mode: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

WriteStream

WriteStream:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

columns

columns: number

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

rows

rows: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

isatty

  • isatty(fd: number): boolean
  • Parameters

    • fd: number

    Returns boolean

"url"

"url":

Url

Url:

auth

auth: string

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

path

path: string

pathname

pathname: string

port

port: string

protocol

protocol: string

query

query: any

search

search: string

slashes

slashes: boolean

UrlOptions

UrlOptions:

auth

auth: string

hash

hash: string

host

host: string

hostname

hostname: string

path

path: string

pathname

pathname: string

port

port: string

protocol

protocol: string

query

query: any

search

search: string

format

  • Parameters

    Returns string

parse

  • parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url
  • Parameters

    • urlStr: string
    • Optional parseQueryString: boolean
    • Optional slashesDenoteHost: boolean

    Returns Url

resolve

  • resolve(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

"util"

"util":

InspectOptions

InspectOptions:

colors

colors: boolean

customInspect

customInspect: boolean

depth

depth: number

showHidden

showHidden: boolean

debug

  • debug(string: string): void
  • Parameters

    • string: string

    Returns void

debuglog

  • debuglog(key: string): function
  • Parameters

    • key: string

    Returns function

      • (msg: string, ...param: any[]): void
      • Parameters

        • msg: string
        • Rest ...param: any[]

        Returns void

error

  • error(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

format

  • format(format: any, ...param: any[]): string
  • Parameters

    • format: any
    • Rest ...param: any[]

    Returns string

inherits

  • inherits(constructor: any, superConstructor: any): void
  • Parameters

    • constructor: any
    • superConstructor: any

    Returns void

inspect

  • inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string
  • inspect(object: any, options: InspectOptions): string
  • Parameters

    • object: any
    • Optional showHidden: boolean
    • Optional depth: number
    • Optional color: boolean

    Returns string

  • Parameters

    Returns string

isArray

  • isArray(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isDate

  • isDate(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isError

  • isError(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isRegExp

  • isRegExp(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

log

  • log(string: string): void
  • Parameters

    • string: string

    Returns void

print

  • print(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

puts

  • puts(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

"vm"

"vm":

Context

Context:

Script

Script:

runInNewContext

  • runInNewContext(sandbox?: Context): void
  • Parameters

    Returns void

runInThisContext

  • runInThisContext(): void
  • Returns void

createContext

  • Parameters

    Returns Context

createScript

  • createScript(code: string, filename?: string): Script
  • Parameters

    • code: string
    • Optional filename: string

    Returns Script

runInContext

  • runInContext(code: string, context: Context, filename?: string): void
  • Parameters

    • code: string
    • context: Context
    • Optional filename: string

    Returns void

runInNewContext

  • runInNewContext(code: string, sandbox?: Context, filename?: string): void
  • Parameters

    • code: string
    • Optional sandbox: Context
    • Optional filename: string

    Returns void

runInThisContext

  • runInThisContext(code: string, filename?: string): void
  • Parameters

    • code: string
    • Optional filename: string

    Returns void

"zlib"

"zlib":

Deflate

Deflate:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

DeflateRaw

DeflateRaw:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Gunzip

Gunzip:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Gzip

Gzip:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Inflate

Inflate:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

InflateRaw

InflateRaw:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Unzip

Unzip:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ZlibOptions

ZlibOptions:

chunkSize

chunkSize: number

dictionary

dictionary: any

level

level: number

memLevel

memLevel: number

strategy

strategy: number

windowBits

windowBits: number

Z_ASCII

Z_ASCII: number

Z_BEST_COMPRESSION

Z_BEST_COMPRESSION: number

Z_BEST_SPEED

Z_BEST_SPEED: number

Z_BINARY

Z_BINARY: number

Z_BLOCK

Z_BLOCK: number

Z_BUF_ERROR

Z_BUF_ERROR: number

Z_DATA_ERROR

Z_DATA_ERROR: number

Z_DEFAULT_COMPRESSION

Z_DEFAULT_COMPRESSION: number

Z_DEFAULT_STRATEGY

Z_DEFAULT_STRATEGY: number

Z_DEFLATED

Z_DEFLATED: number

Z_ERRNO

Z_ERRNO: number

Z_FILTERED

Z_FILTERED: number

Z_FINISH

Z_FINISH: number

Z_FIXED

Z_FIXED: number

Z_FULL_FLUSH

Z_FULL_FLUSH: number

Z_HUFFMAN_ONLY

Z_HUFFMAN_ONLY: number

Z_MEM_ERROR

Z_MEM_ERROR: number

Z_NEED_DICT

Z_NEED_DICT: number

Z_NO_COMPRESSION

Z_NO_COMPRESSION: number

Z_NO_FLUSH

Z_NO_FLUSH: number

Z_NULL

Z_NULL: number

Z_OK

Z_OK: number

Z_PARTIAL_FLUSH

Z_PARTIAL_FLUSH: number

Z_RLE

Z_RLE: number

Z_STREAM_END

Z_STREAM_END: number

Z_STREAM_ERROR

Z_STREAM_ERROR: number

Z_SYNC_FLUSH

Z_SYNC_FLUSH: number

Z_TEXT

Z_TEXT: number

Z_TREES

Z_TREES: number

Z_UNKNOWN

Z_UNKNOWN: number

Z_VERSION_ERROR

Z_VERSION_ERROR: number

createDeflate

  • Parameters

    Returns Deflate

createDeflateRaw

createGunzip

  • Parameters

    Returns Gunzip

createGzip

  • Parameters

    Returns Gzip

createInflate

  • Parameters

    Returns Inflate

createInflateRaw

createUnzip

  • Parameters

    Returns Unzip

deflate

  • deflate(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

deflateRaw

  • deflateRaw(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

deflateRawSync

  • Parameters

    Returns any

deflateSync

  • Parameters

    Returns any

gunzip

  • gunzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gunzipSync

  • Parameters

    Returns any

gzip

  • gzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gzipSync

  • Parameters

    Returns any

inflate

  • inflate(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflateRaw

  • inflateRaw(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflateRawSync

  • Parameters

    Returns any

inflateSync

  • Parameters

    Returns any

unzip

  • unzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

unzipSync

  • Parameters

    Returns any

Chai

Chai:

AssertionError

AssertionError:

constructor

  • new AssertionError(message: string, _props?: any, ssf?: Function): AssertionError
  • Parameters

    • message: string
    • Optional _props: any
    • Optional ssf: Function

    Returns AssertionError

message

message: string

name

name: string

showDiff

showDiff: boolean

stack

stack: string

Assert

  • __call(expression: any, message?: string): void
  • Parameters

    • expression: any

      Expression to test for truthiness.

    • Optional message: string

      Message to display on error.

    Returns void

eventually

eventually: PromisedAssert

Throw

  • Throw(fn: Function, msg?: string): void
  • Throw(fn: Function, regExp: RegExp): void
  • Throw(fn: Function, errType: Function, msg?: string): void
  • Throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

afterDate

  • afterDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

afterTime

  • afterTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

becomes

  • becomes(promise: Thenable<any>, expected: any, message?: string): Thenable<void>
  • Parameters

    • promise: Thenable<any>
    • expected: any
    • Optional message: string

    Returns Thenable<void>

beforeDate

  • beforeDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

beforeTime

  • beforeTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

doesNotBecome

  • doesNotBecome(promise: Thenable<any>, expected: any, message?: string): Thenable<void>
  • Parameters

    • promise: Thenable<any>
    • expected: any
    • Optional message: string

    Returns Thenable<void>

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): void
  • doesNotThrow(fn: Function, regExp: RegExp): void
  • doesNotThrow(fn: Function, errType: Function, msg?: string): void
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

equal

  • equal(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

equalDate

  • equalDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

equalTime

  • equalTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

extensible

  • extensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns void

frozen

  • frozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

ifError

  • ifError(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

include

  • include(exp: string, inc: any, msg?: string): void
  • include(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

includeMembers

  • includeMembers(superset: any[], subset: any[], msg?: string): void
  • Parameters

    • superset: any[]
    • subset: any[]
    • Optional msg: string

    Returns void

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

isAbove

  • isAbove(val: number, abv: number, msg?: string): void
  • Parameters

    • val: number
    • abv: number
    • Optional msg: string

    Returns void

isArray

  • isArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isBelow

  • isBelow(val: number, blw: number, msg?: string): void
  • Parameters

    • val: number
    • blw: number
    • Optional msg: string

    Returns void

isBoolean

  • isBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isDefined

  • isDefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isExtensible

  • isExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isFalse

  • isFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFrozen

  • isFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isFulfilled

  • Parameters

    • promise: Thenable<any>
    • Optional message: string

    Returns Thenable<void>

isFunction

  • isFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNaN

  • isNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotArray

  • isNotArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotBoolean

  • isNotBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotExtensible

  • isNotExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotFrozen

  • isNotFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isNotFunction

  • isNotFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNaN

  • isNotNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNull

  • isNotNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNumber

  • isNotNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotObject

  • isNotObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotOk

  • isNotOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotSealed

  • isNotSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotString

  • isNotString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNull

  • isNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNumber

  • isNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isObject

  • isObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isOk

  • isOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isRejected

  • Parameters

    • promise: Thenable<any>
    • Optional message: string

    Returns Thenable<void>

  • Parameters

    • promise: Thenable<any>
    • expected: any
    • Optional message: string

    Returns Thenable<void>

  • Parameters

    • promise: Thenable<any>
    • match: RegExp
    • Optional message: string

    Returns Thenable<void>

isSealed

  • isSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isString

  • isString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isTrue

  • isTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isUndefined

  • isUndefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): void
  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns void

match

  • match(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notAfterDate

  • notAfterDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notAfterTime

  • notAfterTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notBeforeDate

  • notBeforeDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notBeforeTime

  • notBeforeTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notEqual

  • notEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notEqualDate

  • notEqualDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notEqualTime

  • notEqualTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notExtensible

  • notExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notFrozen

  • notFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

notInclude

  • notInclude(exp: string, inc: any, msg?: string): void
  • notInclude(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notOk

  • notOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notSealed

  • notSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

notify

  • Parameters

    • fn: Function

    Returns Thenable<void>

ok

  • ok(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

operator

  • operator(val: any, operator: string, val2: any, msg?: string): void
  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns void

property

  • property(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

sameDeepMembers

  • sameDeepMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sealed

  • sealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

throw

  • throw(fn: Function, msg?: string): void
  • throw(fn: Function, regExp: RegExp): void
  • throw(fn: Function, errType: Function, msg?: string): void
  • throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

throws

  • throws(fn: Function, msg?: string): void
  • throws(fn: Function, regExp: RegExp): void
  • throws(fn: Function, errType: Function, msg?: string): void
  • throws(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

typeOf

  • typeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

AssertStatic

  • __call(expression: any, message?: string): void
  • Parameters

    • expression: any

      Expression to test for truthiness.

    • Optional message: string

      Message to display on error.

    Returns void

eventually

eventually: PromisedAssert

Throw

  • Throw(fn: Function, msg?: string): void
  • Throw(fn: Function, regExp: RegExp): void
  • Throw(fn: Function, errType: Function, msg?: string): void
  • Throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

afterDate

  • afterDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

afterTime

  • afterTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

becomes

  • becomes(promise: Thenable<any>, expected: any, message?: string): Thenable<void>
  • Parameters

    • promise: Thenable<any>
    • expected: any
    • Optional message: string

    Returns Thenable<void>

beforeDate

  • beforeDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

beforeTime

  • beforeTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

doesNotBecome

  • doesNotBecome(promise: Thenable<any>, expected: any, message?: string): Thenable<void>
  • Parameters

    • promise: Thenable<any>
    • expected: any
    • Optional message: string

    Returns Thenable<void>

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): void
  • doesNotThrow(fn: Function, regExp: RegExp): void
  • doesNotThrow(fn: Function, errType: Function, msg?: string): void
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

equal

  • equal(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

equalDate

  • equalDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

equalTime

  • equalTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

extensible

  • extensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns void

frozen

  • frozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

ifError

  • ifError(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

include

  • include(exp: string, inc: any, msg?: string): void
  • include(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

includeMembers

  • includeMembers(superset: any[], subset: any[], msg?: string): void
  • Parameters

    • superset: any[]
    • subset: any[]
    • Optional msg: string

    Returns void

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

isAbove

  • isAbove(val: number, abv: number, msg?: string): void
  • Parameters

    • val: number
    • abv: number
    • Optional msg: string

    Returns void

isArray

  • isArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isBelow

  • isBelow(val: number, blw: number, msg?: string): void
  • Parameters

    • val: number
    • blw: number
    • Optional msg: string

    Returns void

isBoolean

  • isBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isDefined

  • isDefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isExtensible

  • isExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isFalse

  • isFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFrozen

  • isFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isFulfilled

  • Parameters

    • promise: Thenable<any>
    • Optional message: string

    Returns Thenable<void>

isFunction

  • isFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNaN

  • isNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotArray

  • isNotArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotBoolean

  • isNotBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotExtensible

  • isNotExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotFrozen

  • isNotFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isNotFunction

  • isNotFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNaN

  • isNotNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNull

  • isNotNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNumber

  • isNotNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotObject

  • isNotObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotOk

  • isNotOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotSealed

  • isNotSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotString

  • isNotString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNull

  • isNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNumber

  • isNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isObject

  • isObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isOk

  • isOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isRejected

  • Parameters

    • promise: Thenable<any>
    • Optional message: string

    Returns Thenable<void>

  • Parameters

    • promise: Thenable<any>
    • expected: any
    • Optional message: string

    Returns Thenable<void>

  • Parameters

    • promise: Thenable<any>
    • match: RegExp
    • Optional message: string

    Returns Thenable<void>

isSealed

  • isSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isString

  • isString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isTrue

  • isTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isUndefined

  • isUndefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): void
  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns void

match

  • match(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notAfterDate

  • notAfterDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notAfterTime

  • notAfterTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notBeforeDate

  • notBeforeDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notBeforeTime

  • notBeforeTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notEqual

  • notEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notEqualDate

  • notEqualDate(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notEqualTime

  • notEqualTime(val: Date, exp: Date, msg?: string): void
  • Parameters

    • val: Date
    • exp: Date
    • Optional msg: string

    Returns void

notExtensible

  • notExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notFrozen

  • notFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

notInclude

  • notInclude(exp: string, inc: any, msg?: string): void
  • notInclude(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notOk

  • notOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notSealed

  • notSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

notify

  • Parameters

    • fn: Function

    Returns Thenable<void>

ok

  • ok(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

operator

  • operator(val: any, operator: string, val2: any, msg?: string): void
  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns void

property

  • property(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

sameDeepMembers

  • sameDeepMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sealed

  • sealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

throw

  • throw(fn: Function, msg?: string): void
  • throw(fn: Function, regExp: RegExp): void
  • throw(fn: Function, errType: Function, msg?: string): void
  • throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

throws

  • throws(fn: Function, msg?: string): void
  • throws(fn: Function, regExp: RegExp): void
  • throws(fn: Function, errType: Function, msg?: string): void
  • throws(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

typeOf

  • typeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

Assertion

  • __call(type: string, message?: string): Assertion
  • __call(type: string, message?: string): Assertion
  • Parameters

    • type: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • type: string
    • Optional message: string

    Returns Assertion

Arguments

Arguments: Assertion

NaN

NaN: Assertion

Throw

Throw: Throw

a

above

all

an

and

and: Assertion

any

arguments

arguments: Assertion

at

at: Assertion

be

be: Assertion

been

been: Assertion

below

change

changes

contain

contain: Include

contains

contains: Include

decrease

decrease: PropertyChange

decreases

decreases: PropertyChange

deep

deep: Deep

empty

empty: Assertion

eq

eq: Equal

eql

eql: Equal

eqls

eqls: Equal

equal

equal: Equal

equals

equals: Equal

eventually

eventually: PromisedAssertion

exist

exist: Assertion

extensible

extensible: Assertion

false

false: Assertion

frozen

frozen: Assertion

fulfilled

greaterThan

greaterThan: NumberComparer

gt

gte

has

has: Assertion

have

have: Assertion

haveOwnProperty

haveOwnProperty: OwnProperty

haveOwnPropertyDescriptor

haveOwnPropertyDescriptor: OwnPropertyDescriptor

include

include: Include

includes

includes: Include

increase

increase: PropertyChange

increases

increases: PropertyChange

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

is

is: Assertion

itself

itself: Assertion

keys

keys: Keys

least

length

length: Length

lengthOf

lengthOf: Length

lessThan

lessThan: NumberComparer

lt

lte

match

match: Match

matches

matches: Match

members

members: Members

most

not

not: Assertion

null

null: Assertion

of

of: Assertion

ok

ok: Assertion

ownProperty

ownProperty: OwnProperty

ownPropertyDescriptor

ownPropertyDescriptor: OwnPropertyDescriptor

property

property: Property

rejected

respondTo

respondTo: RespondTo

respondsTo

respondsTo: RespondTo

same

same: Assertion

satisfies

satisfies: Satisfy

satisfy

satisfy: Satisfy

sealed

sealed: Assertion

that

that: Assertion

throw

throw: Throw

throws

throws: Throw

to

to: Assertion

true

true: Assertion

undefined

undefined: Assertion

which

which: Assertion

with

with: Assertion

afterDate

  • afterDate(date: Date): Assertion
  • Parameters

    • date: Date

    Returns Assertion

afterTime

  • afterTime(date: Date): Assertion
  • Parameters

    • date: Date

    Returns Assertion

become

  • Parameters

    • expected: any

    Returns PromisedAssertion

beforeDate

  • beforeDate(date: Date): Assertion
  • Parameters

    • date: Date

    Returns Assertion

beforeTime

  • beforeTime(date: Date): Assertion
  • Parameters

    • date: Date

    Returns Assertion

closeTo

  • closeTo(expected: number, delta: number, message?: string): Assertion
  • Parameters

    • expected: number
    • delta: number
    • Optional message: string

    Returns Assertion

equalDate

  • equalDate(date: Date): Assertion
  • Parameters

    • date: Date

    Returns Assertion

equalTime

  • equalTime(date: Date): Assertion
  • Parameters

    • date: Date

    Returns Assertion

key

  • key(string: string): Assertion
  • Parameters

    • string: string

    Returns Assertion

notify

  • Parameters

    • fn: Function

    Returns PromisedAssertion

rejectedWith

  • Parameters

    • expected: any
    • Optional message: string

    Returns PromisedAssertion

string

  • string(string: string, message?: string): Assertion
  • Parameters

    • string: string
    • Optional message: string

    Returns Assertion

within

  • within(start: number, finish: number, message?: string): Assertion

AssertionStatic

  • __call(target: any, message?: string): Assertion
  • Parameters

    • target: any
    • Optional message: string

    Returns Assertion

ChaiStatic

ChaiStatic:

AssertionError

AssertionError: AssertionError

assert

assert: AssertStatic

config

config: Config

expect

expect: ExpectStatic

should

  • Returns Should

use

  • use(fn: function): any
  • Provides a way to extend the internals of Chai

    Parameters

    • fn: function
        • (chai: any, utils: any): void
        • Parameters

          • chai: any
          • utils: any

          Returns void

    Returns any

Config

Config:

includeStack

includeStack: boolean

Deep

Deep:

equal

equal: Equal

include

include: Include

members

members: Members

property

property: Property

Equal

  • __call(value: any, message?: string): Assertion
  • Parameters

    • value: any
    • Optional message: string

    Returns Assertion

Eventually

  • Parameters

    • type: string
    • Optional message: string

    Returns PromisedAssertion

Arguments

Throw

a

above

an

and

arguments

at

be

been

below

contain

deep

empty

eq

eql

eqls

equal

equals

eventually

eventually: Eventually

exist

false

fulfilled

greaterThan

gt

gte

has

have

haveOwnProperty

haveOwnProperty: PromisedOwnProperty

include

instanceOf

instanceOf: PromisedInstanceOf

instanceof

instanceof: PromisedInstanceOf

is

itself

keys

least

length

lengthOf

lengthOf: PromisedLength

lessThan

lt

lte

members

most

not

null

of

ok

ownProperty

ownProperty: PromisedOwnProperty

property

rejected

same

that

throw

throws

to

true

undefined

which

with

become

closeTo

  • Parameters

    • expected: number
    • delta: number
    • Optional message: string

    Returns PromisedAssertion

key

  • Parameters

    • string: string

    Returns PromisedAssertion

match

  • Parameters

    • regexp: RegExp | string
    • Optional message: string

    Returns PromisedAssertion

notify

  • Parameters

    • fn: Function

    Returns PromisedAssertion

rejectedWith

  • Parameters

    • expected: any

    Returns PromisedAssertion

respondTo

  • Parameters

    • method: string
    • Optional message: string

    Returns PromisedAssertion

satisfy

  • Parameters

    • matcher: Function
    • Optional message: string

    Returns PromisedAssertion

string

  • Parameters

    • string: string
    • Optional message: string

    Returns PromisedAssertion

within

ExpectStatic

  • __call(target: any, message?: string): Assertion
  • Parameters

    • target: any
    • Optional message: string

    Returns Assertion

fail

  • fail(actual?: any, expected?: any, message?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

Include

  • __call(value: Object, message?: string): Assertion
  • __call(value: string, message?: string): Assertion
  • __call(value: number, message?: string): Assertion
  • Parameters

    • value: Object
    • Optional message: string

    Returns Assertion

  • Parameters

    • value: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • value: number
    • Optional message: string

    Returns Assertion

all

any

keys

keys: Keys

members

members: Members

InstanceOf

  • __call(constructor: Object, message?: string): Assertion
  • Parameters

    • constructor: Object
    • Optional message: string

    Returns Assertion

KeyFilter

KeyFilter:

keys

keys: Keys

Keys

  • __call(...keys: string[]): Assertion
  • __call(keys: any[]): Assertion
  • __call(keys: Object): Assertion
  • Parameters

    • Rest ...keys: string[]

    Returns Assertion

  • Parameters

    • keys: any[]

    Returns Assertion

  • Parameters

    • keys: Object

    Returns Assertion

LanguageChains

LanguageChains:

and

and: Assertion

at

at: Assertion

be

be: Assertion

been

been: Assertion

has

has: Assertion

have

have: Assertion

is

is: Assertion

of

of: Assertion

same

same: Assertion

that

that: Assertion

to

to: Assertion

which

which: Assertion

with

with: Assertion

Length

  • __call(length: number, message?: string): Assertion
  • Parameters

    • length: number
    • Optional message: string

    Returns Assertion

above

and

and: Assertion

at

at: Assertion

be

be: Assertion

been

been: Assertion

below

greaterThan

greaterThan: NumberComparer

gt

gte

has

has: Assertion

have

have: Assertion

is

is: Assertion

least

lessThan

lessThan: NumberComparer

lt

lte

most

of

of: Assertion

same

same: Assertion

that

that: Assertion

to

to: Assertion

which

which: Assertion

with

with: Assertion

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

Match

  • __call(regexp: RegExp | string, message?: string): Assertion
  • Parameters

    • regexp: RegExp | string
    • Optional message: string

    Returns Assertion

Members

  • __call(set: any[], message?: string): Assertion
  • Parameters

    • set: any[]
    • Optional message: string

    Returns Assertion

NumberComparer

  • __call(value: number, message?: string): Assertion
  • Parameters

    • value: number
    • Optional message: string

    Returns Assertion

NumericComparison

NumericComparison:

above

below

greaterThan

greaterThan: NumberComparer

gt

gte

least

lessThan

lessThan: NumberComparer

lt

lte

most

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

OwnProperty

  • __call(name: string, message?: string): Assertion
  • Parameters

    • name: string
    • Optional message: string

    Returns Assertion

OwnPropertyDescriptor

  • __call(name: string, descriptor: PropertyDescriptor, message?: string): Assertion
  • __call(name: string, message?: string): Assertion
  • Parameters

    • name: string
    • descriptor: PropertyDescriptor
    • Optional message: string

    Returns Assertion

  • Parameters

    • name: string
    • Optional message: string

    Returns Assertion

PromisedAssert

PromisedAssert:

Throw

  • Throw(fn: Function, msg?: string): Thenable<void>
  • Throw(fn: Function, regExp: RegExp): Thenable<void>
  • Throw(fn: Function, errType: Function, msg?: string): Thenable<void>
  • Throw(fn: Function, errType: Function, regExp: RegExp): Thenable<void>
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns Thenable<void>

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): Thenable<void>
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns Thenable<void>

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): Thenable<void>
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns Thenable<void>

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns Thenable<void>

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns Thenable<void>

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns Thenable<void>

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): Thenable<void>
  • doesNotThrow(fn: Function, regExp: RegExp): Thenable<void>
  • doesNotThrow(fn: Function, errType: Function, msg?: string): Thenable<void>
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): Thenable<void>
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns Thenable<void>

equal

  • equal(act: any, exp: any, msg?: string): Thenable<void>
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns Thenable<void>

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): Thenable<void>
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns Thenable<void>

ifError

  • ifError(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

include

  • include(exp: string, inc: any, msg?: string): Thenable<void>
  • include(exp: any[], inc: any, msg?: string): Thenable<void>
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns Thenable<void>

includeMembers

  • includeMembers(set1: any[], set2: any[], msg?: string): Thenable<void>
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns Thenable<void>

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns Thenable<void>

isArray

  • isArray(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isBoolean

  • isBoolean(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isDefined

  • isDefined(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isFalse

  • isFalse(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isFunction

  • isFunction(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNotArray

  • isNotArray(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNotBoolean

  • isNotBoolean(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNotFunction

  • isNotFunction(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNotNull

  • isNotNull(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNotNumber

  • isNotNumber(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNotObject

  • isNotObject(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNotString

  • isNotString(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNull

  • isNull(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isNumber

  • isNumber(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isObject

  • isObject(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isString

  • isString(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isTrue

  • isTrue(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

isUndefined

  • isUndefined(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): Thenable<void>
  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns Thenable<void>

match

  • match(exp: any, re: RegExp, msg?: string): Thenable<void>
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns Thenable<void>

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): Thenable<void>
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns Thenable<void>

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns Thenable<void>

notEqual

  • notEqual(act: any, exp: any, msg?: string): Thenable<void>
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns Thenable<void>

notInclude

  • notInclude(exp: string, inc: any, msg?: string): Thenable<void>
  • notInclude(exp: any[], inc: any, msg?: string): Thenable<void>
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns Thenable<void>

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns Thenable<void>

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): Thenable<void>
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns Thenable<void>

notOk

  • notOk(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns Thenable<void>

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): Thenable<void>
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns Thenable<void>

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns Thenable<void>

ok

  • ok(val: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • Optional msg: string

    Returns Thenable<void>

operator

  • operator(val: any, operator: string, val2: any, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns Thenable<void>

property

  • property(obj: Object, prop: string, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns Thenable<void>

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns Thenable<void>

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): Thenable<void>
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns Thenable<void>

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): Thenable<void>
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns Thenable<void>

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): Thenable<void>
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns Thenable<void>

throw

  • throw(fn: Function, msg?: string): Thenable<void>
  • throw(fn: Function, regExp: RegExp): Thenable<void>
  • throw(fn: Function, errType: Function, msg?: string): Thenable<void>
  • throw(fn: Function, errType: Function, regExp: RegExp): Thenable<void>
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns Thenable<void>

throws

  • throws(fn: Function, msg?: string): Thenable<void>
  • throws(fn: Function, regExp: RegExp): Thenable<void>
  • throws(fn: Function, errType: Function, msg?: string): Thenable<void>
  • throws(fn: Function, errType: Function, regExp: RegExp): Thenable<void>
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns Thenable<void>

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns Thenable<void>

typeOf

  • typeOf(val: any, type: string, msg?: string): Thenable<void>
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns Thenable<void>

PromisedAssertion

  • Parameters

    • type: string
    • Optional message: string

    Returns PromisedAssertion

Arguments

Throw

a

above

an

and

arguments

at

be

been

below

contain

deep

empty

eq

eql

eqls

equal

equals

eventually

eventually: Eventually

exist

false

fulfilled

greaterThan

gt

gte

has

have

haveOwnProperty

haveOwnProperty: PromisedOwnProperty

include

instanceOf

instanceOf: PromisedInstanceOf

instanceof

instanceof: PromisedInstanceOf

is

itself

keys

least

length

lengthOf

lengthOf: PromisedLength

lessThan

lt

lte

members

most

not

null

of

ok

ownProperty

ownProperty: PromisedOwnProperty

property

rejected

same

that

throw

throws

to

true

undefined

which

with

become

closeTo

  • Parameters

    • expected: number
    • delta: number
    • Optional message: string

    Returns PromisedAssertion

key

match

  • Parameters

    • regexp: RegExp | string
    • Optional message: string

    Returns PromisedAssertion

notify

rejectedWith

respondTo

satisfy

  • Parameters

    • matcher: Function
    • Optional message: string

    Returns PromisedAssertion

string

  • Parameters

    • string: string
    • Optional message: string

    Returns PromisedAssertion

then

  • then<R>(onFulfill?: function, onReject?: function): Thenable<R>
  • Type parameters

    • R

    Parameters

    • Optional onFulfill: function
    • Optional onReject: function

    Returns Thenable<R>

within

PromisedDeep

PromisedDeep:

equal

include

property

PromisedEqual

  • Parameters

    • value: any
    • Optional message: string

    Returns PromisedAssertion

PromisedInclude

  • Parameters

    • value: Object
    • Optional message: string

    Returns PromisedAssertion

  • Parameters

    • value: string
    • Optional message: string

    Returns PromisedAssertion

  • Parameters

    • value: number
    • Optional message: string

    Returns PromisedAssertion

keys

members

PromisedInstanceOf

  • Parameters

    • constructor: Object
    • Optional message: string

    Returns PromisedAssertion

PromisedKeys

  • Parameters

    • Rest ...keys: string[]

    Returns PromisedAssertion

  • Parameters

    • keys: any[]

    Returns PromisedAssertion

PromisedLanguageChains

PromisedLanguageChains:

and

at

be

been

eventually

eventually: Eventually

has

have

is

of

same

that

to

which

with

PromisedLength

  • Parameters

    • length: number
    • Optional message: string

    Returns PromisedAssertion

above

and

at

be

been

below

eventually

eventually: Eventually

greaterThan

gt

gte

has

have

is

least

lessThan

lt

lte

most

of

same

that

to

which

with

within

PromisedMembers

  • Parameters

    • set: any[]
    • Optional message: string

    Returns PromisedAssertion

PromisedNumberComparer

  • Parameters

    • value: number
    • Optional message: string

    Returns PromisedAssertion

PromisedNumericComparison

PromisedNumericComparison:

above

below

greaterThan

gt

gte

least

lessThan

lt

lte

most

within

  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns PromisedAssertion

PromisedOwnProperty

  • Parameters

    • name: string
    • Optional message: string

    Returns PromisedAssertion

PromisedProperty

  • Parameters

    • name: string
    • Optional value: any
    • Optional message: string

    Returns PromisedAssertion

PromisedThrow

  • Returns PromisedAssertion

  • Parameters

    • expected: string
    • Optional message: string

    Returns PromisedAssertion

  • Parameters

    • expected: RegExp
    • Optional message: string

    Returns PromisedAssertion

  • Parameters

    • constructor: Error
    • Optional expected: string
    • Optional message: string

    Returns PromisedAssertion

  • Parameters

    • constructor: Error
    • Optional expected: RegExp
    • Optional message: string

    Returns PromisedAssertion

  • Parameters

    • constructor: Function
    • Optional expected: string
    • Optional message: string

    Returns PromisedAssertion

  • Parameters

    • constructor: Function
    • Optional expected: RegExp
    • Optional message: string

    Returns PromisedAssertion

PromisedTypeComparison

  • Parameters

    • type: string
    • Optional message: string

    Returns PromisedAssertion

instanceOf

instanceOf: PromisedInstanceOf

instanceof

instanceof: PromisedInstanceOf

Property

  • __call(name: string, value?: any, message?: string): Assertion
  • Parameters

    • name: string
    • Optional value: any
    • Optional message: string

    Returns Assertion

PropertyChange

  • __call(object: Object, prop: string, msg?: string): Assertion
  • Parameters

    • object: Object
    • prop: string
    • Optional msg: string

    Returns Assertion

RespondTo

  • __call(method: string, message?: string): Assertion
  • Parameters

    • method: string
    • Optional message: string

    Returns Assertion

Satisfy

  • __call(matcher: Function, message?: string): Assertion
  • Parameters

    • matcher: Function
    • Optional message: string

    Returns Assertion

Should

Should:

Throw

not

throw

equal

  • equal(value1: any, value2: any, message?: string): void
  • Parameters

    • value1: any
    • value2: any
    • Optional message: string

    Returns void

exist

  • exist(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

fail

  • fail(actual: any, expected: any, message?: string, operator?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

ShouldAssertion

ShouldAssertion:

Throw

throw

equal

  • equal(value1: any, value2: any, message?: string): void
  • Parameters

    • value1: any
    • value2: any
    • Optional message: string

    Returns void

exist

  • exist(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

ShouldThrow

  • __call(actual: Function): void
  • __call(actual: Function, expected: string | RegExp, message?: string): void
  • __call(actual: Function, constructor: Error | Function, expected?: string | RegExp, message?: string): void
  • Parameters

    • actual: Function

    Returns void

  • Parameters

    • actual: Function
    • expected: string | RegExp
    • Optional message: string

    Returns void

  • Parameters

    • actual: Function
    • constructor: Error | Function
    • Optional expected: string | RegExp
    • Optional message: string

    Returns void

Throw

  • __call(): Assertion
  • __call(expected: string, message?: string): Assertion
  • __call(expected: RegExp, message?: string): Assertion
  • __call(constructor: Error, expected?: string, message?: string): Assertion
  • __call(constructor: Error, expected?: RegExp, message?: string): Assertion
  • __call(constructor: Function, expected?: string, message?: string): Assertion
  • __call(constructor: Function, expected?: RegExp, message?: string): Assertion
  • Returns Assertion

  • Parameters

    • expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • expected: RegExp
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Error
    • Optional expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Error
    • Optional expected: RegExp
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Function
    • Optional expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Function
    • Optional expected: RegExp
    • Optional message: string

    Returns Assertion

TypeComparison

  • __call(type: string, message?: string): Assertion
  • Parameters

    • type: string
    • Optional message: string

    Returns Assertion

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

NodeJS

NodeJS:
                                          *
          GLOBAL INTERFACES               *
                                          *

ErrnoException

ErrnoException:

Error

Error: ErrorConstructor

code

code: string

errno

errno: number

message

message: string

name

name: string

path

path: string

stack

stack: string

syscall

syscall: string

EventEmitter

EventEmitter:

addListener

  • addListener(event: string, listener: Function): EventEmitter
  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter
  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void
  • Parameters

    • n: number

    Returns void

Global

Global:

Array

Array: ArrayConstructor

ArrayBuffer

ArrayBuffer: ArrayBufferConstructor

Boolean

Boolean: BooleanConstructor

Buffer

Buffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(array: Uint8Array): __type
    • new __type(array: any[]): __type
    • Allocates a new buffer containing the given {str}.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: string

        encoding to use, optional. Default is 'utf8'

      Returns __type

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: any[]

        The octets to store.

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

      Parameters

      • string: string

        string to test.

      • Optional encoding: string

        encoding used to evaluate (defaults to 'utf8')

      Returns number

  • compare: function
    • The same as buf1.compare(buf2).

      Parameters

      Returns number

  • concat: function
    • Returns a buffer which is the result of concatenating all the buffers in the list together.

      If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.

      Parameters

      • list: Buffer[]

        An array of Buffer objects to concatenate

      • Optional totalLength: number

        Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Returns true if {obj} is a Buffer

      Parameters

      • obj: any

        object to test.

      Returns boolean

  • isEncoding: function
    • isEncoding(encoding: string): boolean
    • Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

      Parameters

      • encoding: string

        string to test.

      Returns boolean

DataView

DataView: DataViewConstructor

Date

Date: DateConstructor

Error

Error: ErrorConstructor

EvalError

EvalError: EvalErrorConstructor

Float32Array

Float32Array: Float32ArrayConstructor

Float64Array

Float64Array: Float64ArrayConstructor

Function

Function: FunctionConstructor

GLOBAL

GLOBAL: Global

Infinity

Infinity: number

Int16Array

Int16Array: Int16ArrayConstructor

Int32Array

Int32Array: Int32ArrayConstructor

Int8Array

Int8Array: Int8ArrayConstructor

Intl

Intl: Intl

JSON

JSON: JSON

Map

Map: MapConstructor

Math

Math: Math

NaN

NaN: number

Number

Number: NumberConstructor

Object

Object: ObjectConstructor

Promise

Promise: Function

RangeError

RangeError: RangeErrorConstructor

ReferenceError

ReferenceError: ReferenceErrorConstructor

RegExp

RegExp: RegExpConstructor

Set

Set: SetConstructor

String

String: StringConstructor

Symbol

Symbol: Function

SyntaxError

SyntaxError: SyntaxErrorConstructor

TypeError

TypeError: TypeErrorConstructor

URIError

URIError: URIErrorConstructor

Uint16Array

Uint16Array: Uint16ArrayConstructor

Uint32Array

Uint32Array: Uint32ArrayConstructor

Uint8Array

Uint8Array: Uint8ArrayConstructor

Uint8ClampedArray

Uint8ClampedArray: Function

WeakMap

WeakMap: WeakMapConstructor

WeakSet

WeakSet: WeakSetConstructor

clearImmediate

clearImmediate: function

Type declaration

    • (immediateId: any): void
    • Parameters

      • immediateId: any

      Returns void

clearInterval

clearInterval: function

Type declaration

    • (intervalId: Timer): void
    • Parameters

      Returns void

clearTimeout

clearTimeout: function

Type declaration

    • (timeoutId: Timer): void
    • Parameters

      Returns void

console

console: Console

decodeURI

decodeURI: decodeURI

decodeURIComponent

decodeURIComponent: decodeURIComponent

encodeURI

encodeURI: encodeURI

encodeURIComponent

encodeURIComponent: encodeURIComponent

escape

escape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

eval

eval: eval

gc

gc: function

Type declaration

    • (): void
    • Returns void

global

global: Global

isFinite

isFinite: isFinite

isNaN

isNaN: isNaN

parseFloat

parseFloat: parseFloat

parseInt

parseInt: parseInt

process

process: Process

root

root: Global

setImmediate

setImmediate: function

Type declaration

    • (callback: function, ...args: any[]): any
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Rest ...args: any[]

      Returns any

setInterval

setInterval: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timer
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timer

setTimeout

setTimeout: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timer
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timer

undefined

undefined: any

unescape

unescape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

v8debug

v8debug: any

Process

Process:

arch

arch: string

argv

argv: string[]

config

config: object

Type declaration

  • target_defaults: object
    • cflags: any[]
    • default_configuration: string
    • defines: string[]
    • include_dirs: string[]
    • libraries: string[]
  • variables: object
    • clang: number
    • host_arch: string
    • node_install_npm: boolean
    • node_install_waf: boolean
    • node_prefix: string
    • node_shared_openssl: boolean
    • node_shared_v8: boolean
    • node_shared_zlib: boolean
    • node_use_dtrace: boolean
    • node_use_etw: boolean
    • node_use_openssl: boolean
    • target_arch: string
    • v8_no_strict_aliasing: number
    • v8_use_snapshot: boolean
    • visibility: string

env

env: any

execPath

execPath: string

pid

pid: number

platform

platform: string

stderr

stdin

stdout

title

title: string

version

version: string

versions

versions: object

Type declaration

  • ares: string
  • http_parser: string
  • node: string
  • openssl: string
  • uv: string
  • v8: string
  • zlib: string

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

chdir

  • chdir(directory: string): void
  • Parameters

    • directory: string

    Returns void

cwd

  • cwd(): string
  • Returns string

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

exit

  • exit(code?: number): void
  • Parameters

    • Optional code: number

    Returns void

getgid

  • getgid(): number
  • Returns number

getuid

  • getuid(): number
  • Returns number

hrtime

  • hrtime(time?: number[]): number[]
  • Parameters

    • Optional time: number[]

    Returns number[]

kill

  • kill(pid: number, signal?: string): void
  • Parameters

    • pid: number
    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

memoryUsage

  • memoryUsage(): object
  • Returns object

    • heapTotal: number
    • heapUsed: number
    • rss: number

nextTick

  • nextTick(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setgid

  • setgid(id: number): void
  • setgid(id: string): void
  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

setuid

  • setuid(id: number): void
  • setuid(id: string): void
  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

umask

  • umask(mask?: number): number
  • Parameters

    • Optional mask: number

    Returns number

uptime

  • uptime(): number
  • Returns number

ReadWriteStream

ReadWriteStream:

readable

readable: boolean

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

wrap

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

ReadableStream

ReadableStream:

readable

readable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

Timer

Timer:

ref

  • ref(): void
  • Returns void

unref

  • unref(): void
  • Returns void

WritableStream

WritableStream:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

PromisesAPlus

PromisesAPlus:

PromiseCtor

  • __call<T>(resolver: function): Thenable<T>
  • Type parameters

    • T

    Parameters

    • resolver: function
        • (resolvePromise: function, rejectPromise: function): void
        • Parameters

          • resolvePromise: function
              • (value: T): void
              • Parameters

                • value: T

                Returns void

          • rejectPromise: function
              • (reason: any): void
              • Parameters

                • reason: any

                Returns void

          Returns void

    Returns Thenable<T>

PromiseImpl

PromiseImpl:

constructor

  • Type parameters

    • T

    Parameters

    • resolver: function
        • (resolvePromise: function, rejectPromise: function): void
        • Parameters

          • resolvePromise: function
              • (value: T): void
              • Parameters

                • value: T

                Returns void

          • rejectPromise: function
              • (reason: any): void
              • Parameters

                • reason: any

                Returns void

          Returns void

    Returns PromiseImpl

Thenable

Thenable:

then

  • then<R>(onFulfill?: function, onReject?: function): Thenable<R>
  • Type parameters

    • R

    Parameters

    • Optional onFulfill: function
    • Optional onReject: function

    Returns Thenable<R>

Updraft

Updraft:

Mutate

Mutate:

add

add:

$add

$add: Array<T>

deleter

deleter:

$delete

$delete: Array<T>

increment

increment:

$inc

$inc: number

merge

merge:

$merge

$merge: T

push

push:

$push

$push: Array<T>

setter

setter:

$set

$set: T

splice

splice:

$splice

$splice: Array<Array<number | T>>

unshift

unshift:

$unshift

$unshift: Array<T>

array

array: setter<Array<T>> | push<T> | unshift<T> | splice<T> | merge<T>

bool

bool: primitive

date

date: setter<Date>

enm

none

none: void

num

numArray

numArray: array

obj

obj: primitive | merge<Object> | deleter<string>

objArray

objArray: array

primitive

primitive: setter<T>

set

set: setter<Set<T>> | add<T> | deleter<T>

str

strArray

strArray: array

strSet

strSet: set

Query

Query:

DateConditions

DateConditions:

$after

$after: Date

$before

$before: Date

InCondition

InCondition:

$in

$in: T[]

LikeCondition

LikeCondition:

$like

$like: string

NotLikeCondition

NotLikeCondition:

$notLike

$notLike: string

NumericConditions

NumericConditions:

$gt

$gt: number

$gte

$gte: number

$lt

$lt: number

$lte

$lte: number

SetHasAllConditions

SetHasAllConditions:

$hasAll

$hasAll: T[]

SetHasAnyCondition

SetHasAnyCondition:

$hasAny

$hasAny: T[]

SetHasCondition

SetHasCondition:

$has

$has: T

bool

bool: boolean

date

enm

none

none: void

num

primitive

primitive: T | InCondition<T>

set

str

strSet

strSet: set

escape

  • escape(str: string): string
  • Parameters

    • str: string

    Returns string

ColumnType

ColumnType:

bool

bool:

date

date:

datetime

datetime:

enum

enum:

int

int:

json

json:

real

real:

set

set:

text

text:

OrderBy

OrderBy:

ASC

ASC:

DESC

DESC:

Column

Column:

Column in db. Use static methods to create columns.

constructor

defaultValue

defaultValue: number | boolean | string

element

element: Column

enum

isIndex

isIndex: boolean

isKey

isKey: boolean

type

Default

  • Default(value: number | boolean | string): Column
  • Set a default value for the column

    Parameters

    • value: number | boolean | string

    Returns Column

Index

  • Create an index for this column for faster queries.

    Returns Column

Key

  • Column is the primary key. Only one column can have this set.

    Returns Column

deserialize

  • Parameters

    Returns any

serialize

  • Parameters

    • value: any

    Returns Serializable

Bool

  • create a column with "BOOL" affinity

    Returns Column

Date

  • a javascript Date objct, stored in db as seconds since Unix epoch (time_t) [note: precision is seconds]

    Returns Column

DateTime

  • a javascript Date objct, stored in db as seconds since Unix epoch (time_t) [note: precision is seconds]

    Returns Column

Enum

Int

  • create a column with "INTEGER" affinity

    Returns Column

JSON

  • object will be serialized & restored as JSON text

    Returns Column

Real

  • create a column with "REAL" affinity

    Returns Column

Set

  • unordered collection

    Parameters

    Returns Column

String

  • create a column with "TEXT" affinity

    Returns Column

Text

  • create a column with "TEXT" affinity

    Returns Column

equal

  • Parameters

    Returns boolean

fromSql

  • fromSql(text: string): Column
  • Parameters

    • text: string

    Returns Column

sql

  • Parameters

    Returns string

SQLiteWrapper

SQLiteWrapper:

constructor

db

each

executeSql

readTransaction

run

  • run(sql: string, callback: function): void
  • Parameters

    • sql: string
    • callback: function
        • (): void
        • Returns void

    Returns void

transaction

Store

Store:

constructor

db

keyValueTable

keyValueTable: Table<KeyValue, any, any>

keyValues

keyValues: KeyValueMap

params

tables

tables: TableSpecAny[]

add

  • Parameters

    Returns Promise<any>

createTable

  • createTable<Element, Mutator, Query>(tableSpec: TableSpec<Element, Mutator, Query>): Table<Element, Mutator, Query>
  • Type parameters

    • Element

    • Mutator

    • Query

    Parameters

    • tableSpec: TableSpec<Element, Mutator, Query>

    Returns Table<Element, Mutator, Query>

find

  • find<Element, Query>(table: Table<Element, any, Query>, queryArg: Query | Query[], opts?: FindOpts): Promise<Element[] | number>
  • Type parameters

    • Element

    • Query

    Parameters

    • table: Table<Element, any, Query>
    • queryArg: Query | Query[]
    • Optional opts: FindOpts

    Returns Promise<Element[] | number>

getValue

  • getValue(key: string): any
  • Parameters

    • key: string

    Returns any

loadKeyValues

open

  • Returns Promise<any>

readSchema

setValue

  • setValue(key: string, value: any): Promise<any>
  • Parameters

    • key: string
    • value: any

    Returns Promise<any>

syncTable

Table

Table:

constructor

  • Parameters

    Returns Table

add

add: function

Type declaration

find

find: function

Type declaration

    • Parameters

      • query: Query | Query[]
      • Optional opts: FindOpts

      Returns Promise<Element[] | number>

key

key: KeyType

spec

spec: TableSpec<Element, Mutator, Query>

keyValue

  • keyValue(element: Element | Mutator): KeyType
  • Parameters

    • element: Element | Mutator

    Returns KeyType

WebsqlWrapper

WebsqlWrapper:

constructor

  • new WebsqlWrapper(name: string, version?: string, displayName?: string, estimatedSize?: number, traceCallback?: function): WebsqlWrapper
  • Parameters

    • name: string
    • Optional version: string
    • Optional displayName: string
    • Optional estimatedSize: number
    • Optional traceCallback: function
        • (trace: string): any
        • Parameters

          • trace: string

          Returns any

    Returns WebsqlWrapper

db

traceCallback

traceCallback: function

Type declaration

    • (trace: string): any
    • Parameters

      • trace: string

      Returns any

all

each

readTransaction

stringify

  • stringify(sql: string, params?: string | number): string
  • Parameters

    • sql: string
    • Optional params: string | number

    Returns string

trace

  • trace(sql: string, params?: string | number): void
  • Parameters

    • sql: string
    • Optional params: string | number

    Returns void

transaction

wrapTransaction

BaselineInfo

BaselineInfo:

element

element: Element

rowid

rowid: number

time

time: number

ChangeTableRow

ChangeTableRow:

change

change: string

key

key: KeyType

time

time: number

ColumnSet

ColumnSet:

CreateStoreParams

CreateStoreParams:

db

DbCallback

  • Parameters

    Returns void

DbCommitCallback

  • __call(): void
  • Returns void

DbEachResultCallback

  • Parameters

    Returns void

DbErrorCallback

  • __call(error: Error): void
  • Parameters

    • error: Error

    Returns void

DbResultsCallback

  • Parameters

    Returns void

DbStatement

DbStatement:

params

params: string | number

sql

sql: string

DbTransaction

DbTransaction:

commit

  • Parameters

    Returns void

each

executeSql

  • executeSql(sql: string, params: string | number, callback: DbResultsCallback): void
  • Parameters

    Returns void

DbTransactionCallback

  • Parameters

    Returns void

DbWrapper

DbWrapper:

readTransaction

transaction

EnumClass

EnumClass:

An enum class (e.g. (this one)[https://github.com/adrai/enum]) should provide a static method 'get' to resolve strings into enum values

get

  • Parameters

    • value: string | number

    Returns EnumValue

EnumValue

EnumValue:

toString

  • toString(): string
  • Returns string

FieldSpec

FieldSpec:

FindOpts

FindOpts:

count

count: boolean

fields

fields: FieldSpec

limit

limit: number

offset

offset: number

orderBy

orderBy: OrderBySpec

IDatabase

IDatabase:

all

  • all(sql: string, params?: any[], callback?: function): IDatabase
  • Parameters

    • sql: string
    • Optional params: any[]
    • Optional callback: function
        • (err: Error, rows: any[]): void
        • Parameters

          • err: Error
          • rows: any[]

          Returns void

    Returns IDatabase

each

  • each(sql: string, params?: any[], callback?: function, complete?: function): IDatabase
  • Parameters

    • sql: string
    • Optional params: any[]
    • Optional callback: function
        • (err: Error, row: any): void
        • Parameters

          • err: Error
          • row: any

          Returns void

    • Optional complete: function
        • (err: Error, count: number): void
        • Parameters

          • err: Error
          • count: number

          Returns void

    Returns IDatabase

parallelize

  • parallelize(callback?: function): void
  • Parameters

    • Optional callback: function
        • (): void
        • Returns void

    Returns void

run

  • run(sql: string, callback?: function): IDatabase
  • Parameters

    • sql: string
    • Optional callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns IDatabase

serialize

  • serialize(callback?: function): void
  • Parameters

    • Optional callback: function
        • (): void
        • Returns void

    Returns void

KeyValue

KeyValue:

key

key: string

value

value: any

KeyValueMap

KeyValueMap:

MutationResult

MutationResult:

element

element: Element

isChanged

isChanged: boolean

time

time: number

OrderBySpec

OrderBySpec:

Rejector

  • __call(err: Error): void
  • Parameters

    • err: Error

    Returns void

RenamedColumnSet

RenamedColumnSet:

Resolver

  • __call(param: T): void
  • Parameters

    • param: T

    Returns void

SQLiteTransaction

SQLiteTransaction:

errorCallback

errorCallback: DbErrorCallback

commit

each

executeSql

  • executeSql(sql: string, params: string | number, callback: DbResultsCallback): void

Schema

Schema:

SetTableRow

SetTableRow:

key

key: KeyType

time

time: number

value

value: string

SqliteMasterRow

SqliteMasterRow:

name

name: string

sql

sql: string

tbl_name

tbl_name: string

type

type: string

TableChange

TableChange:

change

change: Mutator

delete

delete: KeyType

save

save: Element

table

table: Table<Element, Mutator, any>

time

time: number

TableSpec

TableSpec:

clazz

clazz: object

Type declaration

columns

columns: ColumnSet

indices

indices: string[]

name

name: string

renamedColumns

renamedColumns: RenamedColumnSet

TypeScriptEnum

TypeScriptEnum:

A typescript enum class will have string keys resolving to the enum values

WebsqlTransaction

WebsqlTransaction:

errorCallback

errorCallback: DbErrorCallback

realTransaction

realTransaction: SQLTransaction

commit

each

executeSql

  • executeSql(sql: string, params: string | number, callback: DbResultsCallback): void

KeyType

KeyType: string | number

Serializable

Serializable: string | number

TableAny

TableAny: Table<any, any, any>

TableSpecAny

TableSpecAny: TableSpec<any, any, any>

COUNT

COUNT: string

MAX_VARIABLES

MAX_VARIABLES: number

ObjectAssign

ObjectAssign: any

ROWID

ROWID: string

assign

assign: any

hasOwnProperty

hasOwnProperty: hasOwnProperty

internalColumn

internalColumn: ColumnSet

internal_column_composed

internal_column_composed: string

internal_column_deleted

internal_column_deleted: string

internal_column_latest

internal_column_latest: string

internal_column_time

internal_column_time: string

internal_prefix

internal_prefix: string

setKey

setKey: string

DbExecuteSequence

applyChanges

buildIndices

  • Parameters

    Returns void

copyData

createChangeTableSpec

  • Parameters

    • table: Table<any, any, any>

    Returns TableSpecAny

createIndices

createInternalTableSpecs

  • Parameters

    • table: Table<any, any, any>

    Returns TableSpecAny[]

createSQLiteWrapper

createSetTableSpecs

createStore

createTable

createWebsqlWrapper

  • createWebsqlWrapper(name: string, version?: string, displayName?: string, estimatedSize?: number, traceCallback?: function): DbWrapper
  • Parameters

    • name: string
    • Optional version: string
    • Optional displayName: string
    • Optional estimatedSize: number
    • Optional traceCallback: function
        • (trace: string): any
        • Parameters

          • trace: string

          Returns any

    Returns DbWrapper

deserializeChange

  • deserializeChange<Mutator>(text: string, spec: TableSpec<any, Mutator, any>): Mutator
  • Type parameters

    • Mutator

    Parameters

    • text: string
    • spec: TableSpec<any, Mutator, any>

    Returns Mutator

deserializeRow

  • Type parameters

    • T

    Parameters

    Returns T

deserializeValue

  • deserializeValue(spec: TableSpecAny, col: string, value: any): any
  • Parameters

    Returns any

dropTable

fromText

  • fromText(text: string): any
  • Parameters

    • text: string

    Returns any

getChangeTableName

  • getChangeTableName(name: string): string
  • Parameters

    • name: string

    Returns string

getChanges

getSetTableName

  • getSetTableName(tableName: string, col: string): string
  • Parameters

    • tableName: string
    • col: string

    Returns string

indexFromSql

  • indexFromSql(sql: string): string[]
  • Parameters

    • sql: string

    Returns string[]

insert

insertElement

invalidateLatest

isEmpty

  • isEmpty(obj: any): boolean
  • Parameters

    • obj: any

    Returns boolean

isMutated

  • isMutated<Element>(a: Element, b: Element): boolean
  • Type parameters

    • Element

    Parameters

    • a: Element
    • b: Element

    Returns boolean

keyOf

  • keyOf(obj: Object): string
  • Parameters

    • obj: Object

    Returns string

loadAllExternals

loadExternals

makeChange

  • makeChange<Mutator>(table: Table<any, Mutator, any>, time: number): (Anonymous function)
  • Type parameters

    • Mutator

    Parameters

    • table: Table<any, Mutator, any>
    • time: number

    Returns (Anonymous function)

makeDelete

  • makeDelete(table: TableAny, time: number): (Anonymous function)
  • Parameters

    Returns (Anonymous function)

makePrintable

  • makePrintable(x: any): string
  • Parameters

    • x: any

    Returns string

makeSave

  • makeSave<Element>(table: Table<Element, any, any>, time: number): (Anonymous function)
  • Type parameters

    • Element

    Parameters

    • table: Table<Element, any, any>
    • time: number

    Returns (Anonymous function)

migrateChangeTable

mutate

  • mutate<Element, Mutator>(value: Element, spec: Mutator): Element
  • Type parameters

    • Element

    • Mutator

    Parameters

    • value: Element
    • spec: Mutator

    Returns Element

popValue

  • popValue<Element>(element: Element, field: string): any
  • Type parameters

    • Element

    Parameters

    • element: Element
    • field: string

    Returns any

renameTable

resolve

reviver

  • reviver(key: string, value: any): any
  • Parameters

    • key: string
    • value: any

    Returns any

runQuery

  • runQuery<Element, Query>(transaction: DbTransaction, table: Table<Element, any, Query>, queryArg: Query | Query[], opts: FindOpts, clazz: object, resultCallback: DbCallback<number | Element[]>): void
  • Type parameters

    • Element

    • Query

    Parameters

    Returns void

selectBaseline

selectableColumns

  • selectableColumns(spec: TableSpecAny, cols: object): string[]
  • Parameters

    Returns string[]

serializeChange

  • serializeChange<Mutator>(change: Mutator, spec: TableSpec<any, Mutator, any>): string
  • Type parameters

    • Mutator

    Parameters

    • change: Mutator
    • spec: TableSpec<any, Mutator, any>

    Returns string

serializeValue

setLatest

shallowCopy

  • shallowCopy<T>(x: T): T
  • Type parameters

    • T

    Parameters

    • x: T

    Returns T

shallowEqual

  • shallowEqual<T>(a: T, b: T): boolean
  • Type parameters

    • T

    Parameters

    • a: T
    • b: T

    Returns boolean

startsWith

  • startsWith(str: string, val: string): boolean
  • Parameters

    • str: string
    • val: string

    Returns boolean

tableFromSql

  • Parameters

    • name: string
    • sql: string

    Returns TableSpecAny

tableKey

  • Parameters

    Returns KeyType

toObject

  • toObject(val: any): any
  • Parameters

    • val: any

    Returns any

toText

  • toText(o: any): string
  • Parameters

    • o: any

    Returns string

verify

  • verify(condition: any, format: string, ...args: any[]): void
  • Use verify() to assert state which your program assumes to be true.

    Provide sprintf-style format (only %s is supported) and arguments to provide information about what broke and what you were expecting.

    Parameters

    • condition: any
    • format: string
    • Rest ...args: any[]

    Returns void

verifyArrayCase

  • verifyArrayCase(value: any, spec: any, c: string): void
  • Parameters

    • value: any
    • spec: any
    • c: string

    Returns void

verifyGetValue

  • verifyGetValue(element: any, field: string | number): any
  • Parameters

    • element: any
    • field: string | number

    Returns any

verifySetCase

  • verifySetCase(value: any, spec: any, c: string): void
  • Parameters

    • value: any
    • spec: any
    • c: string

    Returns void

command

command: object

add

add: string

deleter

deleter: string

increment

increment: string

merge

merge: string

push

push: string

set

set: string

splice

splice: string

unshift

unshift: string

deleteRow_action

deleteRow_action: object

__computed

__computed: object

$set

$set: boolean

keyValueTableSpec

keyValueTableSpec: object

name

name: string

columns

columns: object

key

key: Column

value

value: Column

Classes

Mocha

Mocha:

reporters

reporters:

Base

Base:

constructor

  • Parameters

    Returns Base

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Doc

Doc:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Dot

Dot:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

HTML

HTML:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

HTMLCov

HTMLCov:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSON

JSON:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSONCov

JSONCov:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSONStream

JSONStream:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Landing

Landing:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

List

List:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Markdown

Markdown:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Min

Min:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Nyan

Nyan:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Progress

Progress:

constructor

  • Parameters

    • runner: IRunner
    • Optional options: object
      • Optional close?: string

        String used to indicate the end of the progress bar.

      • Optional complete?: string

        String used to indicate a complete test on the progress bar.

      • Optional incomplete?: string

        String used to indicate an incomplete test on the progress bar.

      • Optional open?: string

        String used to indicate the start of the progress bar.

    Returns Progress

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Spec

Spec:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

TAP

TAP:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

XUnit

XUnit:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

IContextDefinition

  • __call(description: string, spec: function): ISuite
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns ISuite

only

  • only(description: string, spec: function): ISuite
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns ISuite

skip

  • skip(description: string, spec: function): void
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns void

timeout

  • timeout(ms: number): void
  • Parameters

    • ms: number

    Returns void

IRunnable

IRunnable:

Partial interface for Mocha's Runnable class.

async

async: boolean

fn

fn: Function

sync

sync: boolean

timedOut

timedOut: boolean

title

title: string

IRunner

IRunner:

Partial interface for Mocha's Runner class.

ISuite

ISuite:

Partial interface for Mocha's Suite class.

parent

parent: ISuite

title

title: string

fullTitle

  • fullTitle(): string
  • Returns string

ITest

ITest:

Partial interface for Mocha's Test class.

async

async: boolean

fn

fn: Function

parent

parent: ISuite

pending

pending: boolean

sync

sync: boolean

timedOut

timedOut: boolean

title

title: string

fullTitle

  • fullTitle(): string
  • Returns string

ITestDefinition

  • __call(expectation: string, assertion?: function): ITest
  • __call(expectation: string, assertion?: function): ITest
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns ITest

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns ITest

only

  • only(expectation: string, assertion?: function): ITest
  • only(expectation: string, assertion?: function): ITest
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns ITest

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns ITest

skip

  • skip(expectation: string, assertion?: function): void
  • skip(expectation: string, assertion?: function): void
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns void

timeout

  • timeout(ms: number): void
  • Parameters

    • ms: number

    Returns void

constructor

  • new Mocha(options?: object): Mocha
  • Parameters

    • Optional options: object
      • Optional bail?: boolean
      • Optional grep?: RegExp
      • Optional reporter?: string
      • Optional timeout?: number
      • Optional ui?: string

    Returns Mocha

addFile

  • addFile(file: string): Mocha
  • Parameters

    • file: string

    Returns Mocha

asyncOnly

  • asyncOnly(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

bail

  • bail(value?: boolean): Mocha
  • Parameters

    • Optional value: boolean

    Returns Mocha

checkLeaks

  • Returns Mocha

enableTimeouts

  • enableTimeouts(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

globals

  • globals(value: string): Mocha
  • globals(values: string[]): Mocha
  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • values: string[]

    Returns Mocha

grep

  • grep(value: string): Mocha
  • grep(value: RegExp): Mocha
  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • value: RegExp

    Returns Mocha

growl

  • Enables growl support.

    Returns Mocha

ignoreLeaks

  • ignoreLeaks(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

invert

  • Returns Mocha

noHighlighting

  • noHighlighting(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

reporter

  • reporter(name: string): Mocha
  • reporter(reporter: function): Mocha
  • Sets reporter by name, defaults to "spec".

    Parameters

    • name: string

    Returns Mocha

  • Sets reporter constructor, defaults to mocha.reporters.Spec.

    Parameters

    • reporter: function
        • (runner: IRunner, options: any): any
        • Parameters

          Returns any

    Returns Mocha

run

  • run(onComplete?: function): IRunner
  • Runs tests and invokes onComplete() when finished.

    Parameters

    • Optional onComplete: function
        • (failures: number): void
        • Parameters

          • failures: number

          Returns void

    Returns IRunner

setup

  • Setup mocha with the given options.

    Parameters

    Returns Mocha

slow

  • slow(value: number): Mocha
  • Parameters

    • value: number

    Returns Mocha

throwError

  • throwError(error: Error): void
  • Function to allow assertion libraries to throw errors directly into mocha. This is useful when running tests in a browser because window.onerror will only receive the 'message' attribute of the Error.

    Parameters

    • error: Error

    Returns void

timeout

  • timeout(value: number): Mocha
  • Parameters

    • value: number

    Returns Mocha

ui

  • ui(value: string): Mocha
  • Parameters

    • value: string

    Returns Mocha

useColors

  • useColors(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

useInlineDiffs

  • useInlineDiffs(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

Promise

Promise:

constructor

  • new Promise(callback: function): Promise
  • If you call resolve in the body of the callback passed to the constructor, your promise is fulfilled with result object passed to resolve. If you call reject your promise is rejected with the object passed to resolve. For consistency and debugging (eg stack traces), obj should be an instanceof Error. Any errors thrown in the constructor callback will be implicitly passed to reject().

    Parameters

    • callback: function
        • (resolve: function, reject: function): void
        • Parameters

          • resolve: function
              • Parameters

                Returns void

          • reject: function
              • (error?: any): void
              • Parameters

                • Optional error: any

                Returns void

          Returns void

    Returns Promise

catch

  • catch<U>(onRejected?: function): Promise<U>
  • Sugar for promise.then(undefined, onRejected)

    Type parameters

    • U

    Parameters

    • Optional onRejected: function

      called when/if "promise" rejects

    Returns Promise<U>

then

  • then<U>(onFulfilled?: function, onRejected?: function): Promise<U>
  • then<U>(onFulfilled?: function, onRejected?: function): Promise<U>
  • onFulfilled is called when/if "promise" resolves. onRejected is called when/if "promise" rejects. Both are optional, if either/both are omitted the next onFulfilled/onRejected in the chain is called. Both callbacks have a single parameter , the fulfillment value or rejection reason. "then" returns a new promise equivalent to the value you return from onFulfilled/onRejected after being passed through Promise.resolve. If an error is thrown in the callback, the returned promise rejects with that error.

    Type parameters

    • U

    Parameters

    • Optional onFulfilled: function

      called when/if "promise" resolves

    • Optional onRejected: function

      called when/if "promise" rejects

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional onFulfilled: function
    • Optional onRejected: function
        • (error: any): void
        • Parameters

          • error: any

          Returns void

    Returns Promise<U>

all

  • Make a promise that fulfills when every item in the array fulfills, and rejects if (and when) any item rejects. the array passed to all can be a mixture of promise-like objects and other objects. The fulfillment value is an array (in order) of fulfillment values. The rejection value is the first rejection value.

    Type parameters

    • R

    Parameters

    Returns Promise<R[]>

race

  • Make a Promise that fulfills when any item fulfills, and rejects if any item rejects.

    Type parameters

    • R

    Parameters

    Returns Promise<R>

reject

  • Make a promise that rejects to obj. For consistency and debugging (eg stack traces), obj should be an instanceof Error

    Parameters

    • error: any

    Returns Promise<any>

resolve

  • Make a new promise from the thenable. A thenable is promise-like in as far as it has a "then" method.

    Type parameters

    • R

    Parameters

    Returns Promise<R>

Interfaces

Buffer

Buffer:

Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

length

length: number

compare

  • compare(otherBuffer: Buffer): number
  • Parameters

    Returns number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

equals

  • equals(otherBuffer: Buffer): boolean
  • Parameters

    Returns boolean

fill

  • fill(value: any, offset?: number, end?: number): Buffer
  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns Buffer

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number
  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer
  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any
  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string
  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number
  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

Database

Database:

version

version: string

changeVersion

readTransaction

transaction

DatabaseCallback

  • Parameters

    Returns void

Date

Date:

should

should: Assertion

EnumValue

EnumValue:

key

key: string

value

value: number

Error

Error:
                                          *
          Node.js v0.12.0 API             *
                                          *

stack

stack: string

ForEachable

ForEachable:

forEach

  • forEach(callbackfn: function): void
  • Parameters

    • callbackfn: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    Returns void

Iterator

Iterator:

next

  • Parameters

    • Optional value: any

    Returns IteratorResult<T>

return

  • Parameters

    • Optional value: any

    Returns IteratorResult<T>

throw

  • Parameters

    • Optional e: any

    Returns IteratorResult<T>

IteratorResult

IteratorResult:

done

done: boolean

value

value: T

Map

Map:

size

size: number

clear

  • clear(): void
  • Returns void

delete

  • delete(key: K): boolean
  • Parameters

    • key: K

    Returns boolean

entries

  • Returns Iterator<[K, V]>

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Parameters

    • callbackfn: function
        • (value: V, index: K, map: Map<K, V>): void
        • Parameters

          • value: V
          • index: K
          • map: Map<K, V>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: K): V
  • Parameters

    • key: K

    Returns V

has

  • has(key: K): boolean
  • Parameters

    • key: K

    Returns boolean

keys

  • Returns Iterator<K>

set

  • set(key: K, value?: V): Map<K, V>
  • Parameters

    • key: K
    • Optional value: V

    Returns Map<K, V>

values

  • Returns Iterator<V>

MapConstructor

MapConstructor:

constructor

  • Type parameters

    • K

    • V

    Returns MapConstructor

  • Type parameters

    • K

    • V

    Parameters

    Returns MapConstructor

prototype

prototype: Map<any, any>

MochaDone

  • __call(error?: Error): void
  • Parameters

    • Optional error: Error

    Returns void

MochaSetupOptions

MochaSetupOptions:

bail

bail: boolean

globals

globals: any[]

grep

grep: any

ignoreLeaks

ignoreLeaks: boolean

reporter

reporter: any

slow

slow: number

timeout

timeout: number

ui

ui: string

NodeBuffer

NodeBuffer:
deprecated

length

length: number

compare

  • compare(otherBuffer: Buffer): number
  • Parameters

    Returns number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

equals

  • equals(otherBuffer: Buffer): boolean
  • Parameters

    Returns boolean

fill

  • fill(value: any, offset?: number, end?: number): Buffer
  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns Buffer

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number
  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer
  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any
  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string
  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number
  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

NodeModule

NodeModule:

children

children: any[]

exports

exports: any

filename

filename: string

id

id: string

loaded

loaded: boolean

parent

parent: any

require

NodeRequire

  • __call(id: string): any
  • Parameters

    • id: string

    Returns any

cache

cache: any

extensions

extensions: any

main

main: any

resolve

  • resolve(id: string): string
  • Parameters

    • id: string

    Returns string

NodeRequireFunction

  • __call(id: string): any
  • Parameters

    • id: string

    Returns any

Object

Object:

should

should: Assertion

SQLError

SQLError:

CONSTRAINT_ERR

CONSTRAINT_ERR: number

DATABASE_ERR

DATABASE_ERR: number

QUOTA_ERR

QUOTA_ERR: number

SYNTAX_ERR

SYNTAX_ERR: number

TIMEOUT_ERR

TIMEOUT_ERR: number

TOO_LARGE_ERR

TOO_LARGE_ERR: number

UNKNOWN_ERR

UNKNOWN_ERR: number

VERSION_ERR

VERSION_ERR: number

code

code: number

message

message: string

name

name: string

SQLResultSet

SQLResultSet:

insertId

insertId: number

rows

rowsAffected

rowsAffected: number

SQLResultSetRowList

SQLResultSetRowList:

length

length: number

item

  • item(index: number): Object
  • Parameters

    • index: number

    Returns Object

SQLStatementCallback

SQLStatementErrorCallback

SQLTransaction

SQLTransaction:

executeSql

SQLTransactionCallback

  • Parameters

    Returns void

SQLTransactionErrorCallback

  • Parameters

    Returns void

SQLVoidCallback

  • __call(): void
  • Returns void

Set

Set:

size

size: number

add

  • add(value: T): Set<T>
  • Parameters

    • value: T

    Returns Set<T>

clear

  • clear(): void
  • Returns void

delete

  • delete(value: T): boolean
  • Parameters

    • value: T

    Returns boolean

entries

  • Returns Iterator<[T, T]>

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Parameters

    • callbackfn: function
        • (value: T, index: T, set: Set<T>): void
        • Parameters

          • value: T
          • index: T
          • set: Set<T>

          Returns void

    • Optional thisArg: any

    Returns void

has

  • has(value: T): boolean
  • Parameters

    • value: T

    Returns boolean

keys

  • Returns Iterator<T>

values

  • Returns Iterator<T>

SetConstructor

SetConstructor:

constructor

  • Type parameters

    • T

    Returns SetConstructor

  • Type parameters

    • T

    Parameters

    Returns SetConstructor

prototype

prototype: Set<any>

Thenable

Thenable:

then

  • then<U>(onFulfilled?: function, onRejected?: function): Thenable<U>
  • then<U>(onFulfilled?: function, onRejected?: function): Thenable<U>
  • Type parameters

    • U

    Parameters

    • Optional onFulfilled: function
    • Optional onRejected: function

    Returns Thenable<U>

  • Type parameters

    • U

    Parameters

    • Optional onFulfilled: function
    • Optional onRejected: function
        • (error: any): void
        • Parameters

          • error: any

          Returns void

    Returns Thenable<U>

WeakMap

WeakMap:

clear

  • clear(): void
  • Returns void

delete

  • delete(key: K): boolean
  • Parameters

    • key: K

    Returns boolean

get

  • get(key: K): V
  • Parameters

    • key: K

    Returns V

has

  • has(key: K): boolean
  • Parameters

    • key: K

    Returns boolean

set

  • set(key: K, value?: V): WeakMap<K, V>
  • Parameters

    • key: K
    • Optional value: V

    Returns WeakMap<K, V>

WeakMapConstructor

WeakMapConstructor:

constructor

  • Type parameters

    • K

    • V

    Returns WeakMapConstructor

  • Type parameters

    • K

    • V

    Parameters

    Returns WeakMapConstructor

prototype

prototype: WeakMap<any, any>

WeakSet

WeakSet:

add

  • Parameters

    • value: T

    Returns WeakSet<T>

clear

  • clear(): void
  • Returns void

delete

  • delete(value: T): boolean
  • Parameters

    • value: T

    Returns boolean

has

  • has(value: T): boolean
  • Parameters

    • value: T

    Returns boolean

WeakSetConstructor

WeakSetConstructor:

constructor

  • Type parameters

    • T

    Returns WeakSetConstructor

  • Type parameters

    • T

    Parameters

    Returns WeakSetConstructor

prototype

prototype: WeakSet<any>

Window

Window:

openDatabase

  • openDatabase(name: string, version: string, displayName: string, estimatedSize: number, creationCallback?: DatabaseCallback): Database
  • Parameters

    • name: string
    • version: string
    • displayName: string
    • estimatedSize: number
    • Optional creationCallback: DatabaseCallback

    Returns Database

Variables

SlowBuffer

SlowBuffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(size: Uint8Array): __type
    • new __type(array: any[]): __type
    • Parameters

      • str: string
      • Optional encoding: string

      Returns __type

    • Parameters

      • size: number

      Returns __type

    • Parameters

      • size: Uint8Array

      Returns __type

    • Parameters

      • array: any[]

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Parameters

      • string: string
      • Optional encoding: string

      Returns number

  • concat: function
    • Parameters

      • list: Buffer[]
      • Optional totalLength: number

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Parameters

      • obj: any

      Returns boolean

___dirname

___dirname: string

___filename

___filename: string

chai

context

describe

exports

exports: any

global

global: Global

it

mocha

mocha: Mocha

module

module: NodeModule

process

process: Process
                                          *
              GLOBAL                      *
                                          *

require

require: NodeRequire

suite

test

xdescribe

xit

Functions

after

  • after(action: function): void
  • after(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

afterEach

  • afterEach(action: function): void
  • afterEach(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

before

  • before(action: function): void
  • before(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

beforeEach

  • beforeEach(action: function): void
  • beforeEach(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

clearImmediate

  • clearImmediate(immediateId: any): void
  • Parameters

    • immediateId: any

    Returns void

clearInterval

  • clearInterval(intervalId: Timer): void
  • Parameters

    Returns void

clearTimeout

  • clearTimeout(timeoutId: Timer): void
  • Parameters

    Returns void

setImmediate

  • setImmediate(callback: function, ...args: any[]): any
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Rest ...args: any[]

    Returns any

setInterval

  • setInterval(callback: function, ms: number, ...args: any[]): Timer
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

setTimeout

  • setTimeout(callback: function, ms: number, ...args: any[]): Timer
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

setup

  • setup(action: function): void
  • setup(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

suiteSetup

  • suiteSetup(action: function): void
  • suiteSetup(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

suiteTeardown

  • suiteTeardown(action: function): void
  • suiteTeardown(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

teardown

  • teardown(action: function): void
  • teardown(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc